Struct 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 name_mut(&mut self) -> Option<&mut KdlIdentifier>

Gets a mutable reference to this node’s name.

pub fn set_name(&mut self, name: Option<impl Into<KdlIdentifier>>)

Sets this node’s name.

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

Available on crate feature span only.

Gets this entry’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 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 format(&self) -> Option<&KdlEntryFormat>

Gets the formatting details for this entry.

pub fn format_mut(&mut self) -> Option<&mut KdlEntryFormat>

Gets a mutable reference to this entry’s formatting details.

pub fn set_format(&mut self, format: KdlEntryFormat)

Sets the formatting details for this entry.

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

Creates a new Property (key/value) KdlEntry.

pub fn clear_format(&mut self)

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

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 keep_format(&mut self)

Keeps the general entry formatting, though v1 entries will still be updated to v2 while preserving as much as possible.

pub fn autoformat(&mut self)

Auto-formats this entry.

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.

pub fn ensure_v2(&mut self)

Makes sure this entry is in v2 format.

pub fn ensure_v1(&mut self)

Available on crate feature v1 only.

Makes sure this entry is in v1 format.

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 KdlEntry

where K: Into<KdlIdentifier>, V: Into<KdlValue>,

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

Converts to this type from the input type.

impl From<KdlEntry> for KdlEntry

Available on crate feature v1 only.

fn from(value: KdlEntry) -> Self

Converts to this type from the input type.

impl<T> From<T> for KdlEntry

where 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 Hash for KdlEntry

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 KdlEntry

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 KdlEntry