Struct kdl::KdlEntry

pub struct KdlEntry { /* private fields */ }

KDL Entries are the “arguments” to KDL nodes: either a (positional) Argument or a (key/value) Property

Implementations

impl KdlEntry

pub fn new(value: impl Into<KdlValue>) -> Self

Creates a new Argument (positional) KdlEntry.

pub fn name(&self) -> Option<&KdlIdentifier>

Gets a reference to this entry’s name, if it’s a property entry.

pub fn value(&self) -> &KdlValue

Gets the entry’s value.

pub fn value_mut(&mut self) -> &mut KdlValue

Gets a mutable reference to this entry’s value.

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

Sets the entry’s value.

pub fn span(&self) -> &SourceSpan

Gets this entry’s span.

This value will be properly initialized when created via [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 span_mut(&mut self) -> &mut SourceSpan

Gets a mutable reference to this entry’s span.

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

Sets this entry’s span.

pub fn ty(&self) -> Option<&KdlIdentifier>

Gets the entry’s type.

pub fn ty_mut(&mut self) -> Option<&mut KdlIdentifier>

Gets a mutable reference to this entry’s type.

pub fn set_ty(&mut self, ty: impl Into<KdlIdentifier>)

Sets the entry’s type.

pub fn new_prop(
    key: impl Into<KdlIdentifier>,
    value: impl Into<KdlValue>
) -> Self

Creates a new Property (key/value) KdlEntry.

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

Gets leading text (whitespace, comments) for this KdlEntry.

pub fn set_leading(&mut self, leading: impl Into<String>)

Sets leading text (whitespace, comments) for this KdlEntry.

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

Gets trailing text (whitespace, comments) for this KdlEntry.

pub fn set_trailing(&mut self, trailing: impl Into<String>)

Sets trailing text (whitespace, comments) for this KdlEntry.

pub fn clear_fmt(&mut self)

Clears leading and trailing text (whitespace, comments), as well as resetting this entry’s value to its default representation.

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

Gets the custom string representation for this KdlEntry’s KdlValue.

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

Sets a custom string representation for this KdlEntry’s KdlValue.

pub fn len(&self) -> usize

Length of this entry when rendered as a string.

pub fn is_empty(&self) -> bool

Returns true if this entry is completely empty (including whitespace).

pub fn fmt(&mut self)

Auto-formats this entry.

Trait Implementations

impl Clone for KdlEntry

fn clone(&self) -> KdlEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KdlEntry

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

Formats the value using the given formatter.

impl Display for KdlEntry

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

Formats the value using the given formatter.

impl<K, V> From<(K, V)> for KdlEntrywhere
    K: Into<KdlIdentifier>,
    V: Into<KdlValue>,

fn from((key, value): (K, V)) -> Self

Converts to this type from the input type.

impl<T> From<T> for KdlEntrywhere
    T: Into<KdlValue>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl FromStr for KdlEntry

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 PartialEq<KdlEntry> for KdlEntry

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

This method tests for self and other values to be equal, and is used by ==.

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

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