Struct bracket::parser::ast::Component

pub struct Component<'source> { /* fields omitted */ }

Components form part of a path.

Implementations

impl<'source> Component<'source>

pub fn new(
    source: &'source str,
    kind: ComponentType,
    span: Range<usize>,
    value: Option<String>
) -> Self

Create a new component path.

If a component path contains escape sequences an owned value should be given otherwise the component path will use the supplied span.

pub fn is_root(&self) -> bool

Determine if this is the special @root component.

pub fn kind(&self) -> &ComponentType

Get the kind of this component.

pub fn span(&self) -> &Range<usize>

The span for this component.

pub fn is_local(&self) -> bool

Determine if this component is a local identifier; begins with an @ symbol.

pub fn is_identifier(&self) -> bool

Determine if this component is an identifier.

pub fn is_explicit(&self) -> bool

Determine if this component uses an explicit this reference; the reference may be the keyword this or ./.

pub fn is_explicit_dot_slash(&self) -> bool

Determine if this component uses and explicit dot slash (./) reference.

This is used by the path parser to determine if the next expected token should be a path delimiter or identifier.

pub fn as_value(&self) -> &str

Get the underlying value for the path component.

If an owned value has been given to this path component (which is necessary when the path component includes escape sequences) then a reference to the owned value is returned otherwise a string slice into the original template for the span assigned to this component path is returned.

When performing lookup of values using a path a caller must use this function and not as_str() otherwise literal strings with escape sequences will not be respected.

Trait Implementations

impl<'_> Debug for Component<'_>

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

Formats the value using the given formatter.

impl<'_> Display for Component<'_>

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

Formats the value using the given formatter.

impl<'source> Eq for Component<'source>

impl<'source> PartialEq<Component<'source>> for Component<'source>

fn eq(&self, other: &Component<'source>) -> bool

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

fn ne(&self, other: &Component<'source>) -> bool

This method tests for !=.

impl<'source> Slice<'source> for Component<'source>

fn as_str(&self) -> &'source str

Get a string slice of the full span for this node.

fn source(&self) -> &'source str

Get the underlying template source.

impl<'source> StructuralEq for Component<'source>

impl<'source> StructuralPartialEq for Component<'source>