Struct rstml::node::RawText

pub struct RawText<C = Infallible> { /* private fields */ }

Raw unquoted text

Internally it is valid TokenStream (stream of rust code tokens). So, it has few limitations:

1. It cant contain any unclosed branches, braces or parens.
2. Some tokens like ’ ` can be treated as invalid, because in rust it only allowed in certain contexts.

Can be formatted to a string using to_source_text, to_token_stream_string or to_string_best methods.

Note: It use Span::source_text to retrieve source text with spaces source_text method is not available in quote! context, or in context where input is generated by another macro. In still can return default formatting for TokenStream.

Implementations

impl<C> RawText<C>

pub fn convert_custom<U>(self) -> RawText<U>

Custom node type parameter is used only for parsing, so it can be changed during usage.

pub fn to_token_stream_string(&self) -> String

Convert to string using Display implementation of inner token stream.

pub fn to_source_text(&self, with_whitespaces: bool) -> Option<String>

Try to get source text of the token stream. Internally uses Span::source_text and Span::join, so it can be not available.

Optionally including whitespaces. Whitespaces can be recovered only if before and after RawText was other valid Node.

pub fn join_spans(&self) -> Option<Span>

Return Spans for all unquoted text or nothing. Usefull to detect is Span::join is available or not.

pub fn is_empty(&self) -> bool

pub fn to_string_best(&self) -> String

Trying to return best string representation available:

1. calls to_source_text_hack().
2. calls to_source_text(true)
3. calls to_source_text(false)
4. as fallback calls to_token_stream_string()

pub fn to_source_text_hack(&self) -> Option<String>

impl RawText

pub fn is_source_text_available() -> bool

Returns true if we on nightly rust and join_spans available

Trait Implementations

impl<C> Clone for RawText<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for RawText<C>

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

Formats the value using the given formatter.

impl<C> Default for RawText<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: CustomNode> From<TokenStream> for RawText<C>

fn from(token_stream: TokenStream) -> Self

Converts to this type from the input type.

impl<C: CustomNode> ParseRecoverable for RawText<C>

fn parse_recoverable( parser: &mut RecoverableContext, input: ParseStream<'_>, ) -> Option<Self>

impl<C: CustomNode> ToTokens for RawText<C>

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.