Struct KdlIdentifier

pub struct KdlIdentifier { /* private fields */ }

Represents a KDL Identifier.

Implementations

impl KdlIdentifier

pub fn value(&self) -> &str

Gets the string value for this identifier.

pub fn set_value(&mut self, value: impl Into<String>)

Sets the string value for this identifier.

pub fn span(&self) -> SourceSpan

Available on crate feature span only.

Gets this identifier’s span.

This value will be properly initialized when created via crate::KdlDocument::parse but may become invalidated if the document is mutated. We do not currently guarantee this to yield any particularly consistent results at that point.

pub fn set_span(&mut self, span: impl Into<SourceSpan>)

Available on crate feature span only.

Sets this identifier’s span.

pub fn repr(&self) -> Option<&str>

Gets the custom string representation for this identifier, if any.

pub fn set_repr(&mut self, repr: impl Into<String>)

Sets a custom string representation for this identifier.

pub fn len(&self) -> usize

Length of this identifier when rendered as a string.

pub fn is_empty(&self) -> bool

Returns true if this identifier is completely empty.

pub fn clear_format(&mut self)

Resets this identifier to its default representation. It will attempt to make it an unquoted identifier, and fall back to a string representation if that would be invalid.

pub fn autoformat(&mut self)

Auto-formats this identifier.

pub fn parse(s: &str) -> Result<Self, KdlError>

Parses a string into a entry.

If the v1-fallback feature is enabled, this method will first try to parse the string as a KDL v2 entry, and, if that fails, it will try to parse again as a KDL v1 entry. If both fail, only the v2 parse errors will be returned.

pub fn parse_v1(s: &str) -> Result<Self, KdlError>

Available on crate feature v1 only.

Parses a KDL v1 string into an entry.

Trait Implementations

impl Clone for KdlIdentifier

fn clone(&self) -> KdlIdentifier

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KdlIdentifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for KdlIdentifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for KdlIdentifier

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<KdlIdentifier> for KdlIdentifier

Available on crate feature v1 only.

fn from(value: KdlIdentifier) -> Self

Converts to this type from the input type.

impl From<KdlIdentifier> for String

fn from(value: KdlIdentifier) -> Self

Converts to this type from the input type.

impl From<String> for KdlIdentifier

fn from(value: String) -> Self

Converts to this type from the input type.

impl FromStr for KdlIdentifier

type Err = KdlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for KdlIdentifier

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KdlIdentifier

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for KdlIdentifier