Enum Sexpr

pub enum Sexpr<'src> {
    List(Sexprs<'src>),
    Group(Sexprs<'src>),
    String(Cow<'src, [u8]>),
    Atom(&'src [u8]),
    Comment(&'src [u8]),
}

A single node of the tree. The Atom and String variants reference the input slice. For an owned version have a look at OwnedSexpr.

Display

Sexpr implements the Display trait for serializing to strings. By default, the output will try to minimize the amount of spaces used and the resulting output will be on one line. Enabling the formatter’s alternate flag using #, causes the output to be human-friendly / pretty-printed. Setting the precision with . additionally allows to specify the number of spaces used for indentation (2 by default).

For example:

let sexpr = rsexpr::from_slice(b"[ a b c ]").unwrap();
assert_eq!(format!("{sexpr}"), "[a b c]");
assert_eq!(format!("{sexpr:#}"), "[
  a
  b
  c
]");
assert_eq!(format!("{sexpr:#.4}"), "[
    a
    b
    c
]");

Variants

List(Sexprs<'src>)

A list of Sexprs surrounded by parentheses (, )

Group(Sexprs<'src>)

A list of Sexprs surrounded by brackets [, ]

String(Cow<'src, [u8]>)

A sequence of bytes surrounded by quotes "

Atom(&'src [u8])

A sequence of bytes not including whitespace, parens, and quotes

Comment(&'src [u8])

Available on crate feature comments only.

A line comment, including the leading ;

Implementations

impl<'src> Sexpr<'src>

pub fn unwrap_list(self) -> Sexprs<'src>

Returns the contained List value, consuming self.

Panics

Panics if self is not List.

pub fn unwrap_list_ref(&self) -> &Sexprs<'src>

Returns the contained List value by reference.

Panics

Panics if self is not List.

pub fn unwrap_group(self) -> Sexprs<'src>

Returns the contained Group value, consuming self.

Panics

Panics if self is not Group.

pub fn unwrap_group_ref(&self) -> &Sexprs<'src>

Returns the contained Group value by reference.

Panics

Panics if self is not Group.

pub fn unwrap_string(self) -> Cow<'src, [u8]>

Returns the contained String value, consuming self.

Panics

Panics if self is not String.

pub fn unwrap_string_ref(&self) -> &Cow<'src, [u8]>

Returns the contained String value by reference.

Panics

Panics if self is not String.

pub fn unwrap_atom(self) -> &'src [u8]

Returns the contained Atom value, consuming self.

Panics

Panics if self is not Atom.

pub fn unwrap_atom_ref(&self) -> &&'src [u8]

Returns the contained Atom value by reference.

Panics

Panics if self is not Atom.

Trait Implementations

impl<'src> Clone for Sexpr<'src>

fn clone(&self) -> Sexpr<'src>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for Sexpr<'src>

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

Formats the value using the given formatter.

impl Display for Sexpr<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a OwnedSexpr> for Sexpr<'a>

fn from(value: &'a OwnedSexpr) -> Self

Converts to this type from the input type.

impl From<Sexpr<'_>> for OwnedSexpr

fn from(value: Sexpr<'_>) -> Self

Converts to this type from the input type.

impl<'src> FromIterator<Sexpr<'src>> for Sexprs<'src>

fn from_iter<T: IntoIterator<Item = Sexpr<'src>>>(iter: T) -> Self

Creates a value from an iterator.

impl<'src> Hash for Sexpr<'src>

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<'src> PartialEq for Sexpr<'src>

fn eq(&self, other: &Sexpr<'src>) -> 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<'src> Eq for Sexpr<'src>

impl<'src> StructuralPartialEq for Sexpr<'src>