Struct FStringValue 

pub struct FStringValue { /* private fields */ }

The value representing an ExprFString.

Implementations

impl FStringValue

pub fn single(value: FString) -> Self

Creates a new f-string literal with a single FString part.

pub fn concatenated(values: Vec<FStringPart>) -> Self

Creates a new f-string with the given values that represents an implicitly concatenated f-string.

Panics

Panics if values has less than 2 elements. Use FStringValue::single instead.

pub fn is_implicit_concatenated(&self) -> bool

Returns true if the f-string is implicitly concatenated, false otherwise.

pub fn as_slice(&self) -> &[FStringPart]

Returns a slice of all the FStringParts contained in this value.

pub fn iter(&self) -> Iter<'_, FStringPart>

Returns an iterator over all the FStringParts contained in this value.

pub fn iter_mut(&mut self) -> IterMut<'_, FStringPart>

Returns an iterator over all the FStringParts contained in this value that allows modification.

pub fn literals(&self) -> impl Iterator<Item = &StringLiteral>

Returns an iterator over the StringLiteral parts contained in this value.

Note that this doesn’t recurse into the f-string parts. For example,

"foo" f"bar {x}" "baz" f"qux"

Here, the string literal parts returned would be "foo" and "baz".

pub fn f_strings(&self) -> impl Iterator<Item = &FString>

Returns an iterator over the FString parts contained in this value.

Note that this doesn’t recurse into the f-string parts. For example,

"foo" f"bar {x}" "baz" f"qux"

Here, the f-string parts returned would be f"bar {x}" and f"qux".

pub fn elements(&self) -> impl Iterator<Item = &InterpolatedStringElement>

Returns an iterator over all the InterpolatedStringElement contained in this value.

An f-string element is what makes up an FString i.e., it is either a string literal or an expression. In the following example,

"foo" f"bar {x}" "baz" f"qux"

The f-string elements returned would be string literal ("bar "), expression (x) and string literal ("qux").

pub fn is_empty_literal(&self) -> bool

Returns true if the node represents an empty f-string literal.

Note that a FStringValue node will always have >= 1 FStringParts inside it. This method checks whether the value of the concatenated parts is equal to the empty f-string, not whether the f-string has 0 parts inside it.

Trait Implementations

impl Clone for FStringValue

fn clone(&self) -> FStringValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FStringValue

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

Formats the value using the given formatter.

impl<'a> From<&'a FStringValue> for ComparableFString<'a>

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

Converts to this type from the input type.

impl<'a> IntoIterator for &'a FStringValue

type Item = &'a FStringPart

The type of the elements being iterated over.

type IntoIter = Iter<'a, FStringPart>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut FStringValue

type Item = &'a mut FStringPart

The type of the elements being iterated over.

type IntoIter = IterMut<'a, FStringPart>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for FStringValue

fn eq(&self, other: &FStringValue) -> 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 StructuralPartialEq for FStringValue