Struct TStringFlags 

pub struct TStringFlags(/* private fields */);

Flags that can be queried to obtain information regarding the prefixes and quotes used for an f-string.

Note: This is identical to FStringFlags except that the implementation of the prefix method of the StringFlags trait returns a variant of AnyStringPrefix::Template.

Notes on usage

If you’re using a Generator from the ruff_python_codegen crate to generate a lint-rule fix from an existing t-string literal, consider passing along the FString::flags field. If you don’t have an existing literal but have a Checker from the ruff_linter crate available, consider using Checker::default_tstring_flags to create instances of this struct; this method will properly handle nested t-strings. For usage that doesn’t fit into one of these categories, the public constructor TStringFlags::empty can be used.

Implementations

impl TStringFlags

pub fn empty() -> Self

Construct a new TStringFlags with no flags set.

See TStringFlags::with_quote_style, TStringFlags::with_triple_quotes, and TStringFlags::with_prefix for ways of setting the quote style (single or double), enabling triple quotes, and adding prefixes (such as r), respectively.

See the documentation for TStringFlags for additional caveats on this constructor, and situations in which alternative ways to construct this struct should be used, especially when writing lint rules.

pub fn with_quote_style(self, quote_style: Quote) -> Self

pub fn with_triple_quotes(self, triple_quotes: TripleQuotes) -> Self

pub fn with_unclosed(self, unclosed: bool) -> Self

pub fn with_prefix(self, prefix: TStringPrefix) -> Self

pub const fn prefix(self) -> TStringPrefix

Trait Implementations

impl Clone for TStringFlags

fn clone(&self) -> TStringFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TStringFlags

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

Formats the value using the given formatter.

impl From<AnyStringFlags> for TStringFlags

fn from(value: AnyStringFlags) -> TStringFlags

Converts to this type from the input type.

impl From<TStringFlags> for AnyStringFlags

fn from(value: TStringFlags) -> Self

Converts to this type from the input type.

impl Hash for TStringFlags

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 PartialEq for TStringFlags

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

fn triple_quotes(self) -> TripleQuotes

Return true if the t-string is triple-quoted, i.e., it begins and ends with three consecutive quote characters. For example: t"""{bar}"""

fn quote_style(self) -> Quote

Return the quoting style (single or double quotes) used by the t-string’s opener and closer:

• t"{"a"}" -> QuoteStyle::Double
• t'{"a"}' -> QuoteStyle::Single

fn prefix(self) -> AnyStringPrefix

fn is_unclosed(self) -> bool

fn is_triple_quoted(self) -> bool

Is the string triple-quoted, i.e., does it begin and end with three consecutive quote characters?

fn quote_str(self) -> &'static str

A str representation of the quotes used to start and close. This does not include any prefixes the string has in its opener.

fn quote_len(self) -> TextSize

The length of the quotes used to start and close the string. This does not include the length of any prefixes the string has in its opener.

fn opener_len(self) -> TextSize

The total length of the string’s opener, i.e., the length of the prefixes plus the length of the quotes used to open the string.

fn closer_len(self) -> TextSize

The total length of the string’s closer. This is always equal to self.quote_len(), except when the string is unclosed, in which case the length is zero.

fn as_any_string_flags(self) -> AnyStringFlags

fn display_contents(self, contents: &str) -> DisplayFlags<'_>

impl Copy for TStringFlags

impl Eq for TStringFlags

impl StructuralPartialEq for TStringFlags