Struct Word 

pub struct Word {
    pub value: String,
    pub loc: Option<SourceSpan>,
}

Represents a shell word.

Fields

value: String

Raw text of the word.

loc: Option<SourceSpan>

Location of the word

Implementations

impl Word

pub fn new(s: &str) -> Self

Constructs a new Word from a given string.

pub fn with_location(s: &str, loc: &SourceSpan) -> Self

Constructs a new Word from a given string and location.

pub fn flatten(&self) -> String

Returns the raw text of the word, consuming the Word.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Word

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<str> for Word

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Word

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Word

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Word

Available on crate features serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Word

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

Formats the value using the given formatter.

impl Eq for Word

Available on crate features serde only.

impl From<&Token> for Word

fn from(t: &Token) -> Self

Converts to this type from the input type.

impl From<String> for Word

fn from(s: String) -> Self

Converts to this type from the input type.

impl Node for Word

impl PartialEq for Word

Available on crate features serde only.

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Word

Available on crate features serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceLocation for Word

fn location(&self) -> Option<SourceSpan>

The location of the syntax item, when known

impl StructuralPartialEq for Word

Available on crate features serde only.