Struct StringLiteralFlags 

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

Flags that can be queried to obtain information regarding the prefixes and quotes used for a string literal.

Notes on usage

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

Implementations

impl StringLiteralFlags

pub fn empty() -> Self

Construct a new StringLiteralFlags with no flags set.

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

See the documentation for StringLiteralFlags 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: StringLiteralPrefix) -> Self

pub fn with_invalid(self) -> Self

pub const fn prefix(self) -> StringLiteralPrefix

Trait Implementations

impl Clone for StringLiteralFlags

fn clone(&self) -> StringLiteralFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringLiteralFlags

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

Formats the value using the given formatter.

impl From<AnyStringFlags> for StringLiteralFlags

fn from(value: AnyStringFlags) -> StringLiteralFlags

Converts to this type from the input type.

impl From<StringLiteralFlags> for AnyStringFlags

fn from(value: StringLiteralFlags) -> Self

Converts to this type from the input type.

impl Hash for StringLiteralFlags

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 StringLiteralFlags

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

fn quote_style(self) -> Quote

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

• "a" -> QuoteStyle::Double
• 'a' -> QuoteStyle::Single

fn triple_quotes(self) -> TripleQuotes

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

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 StringLiteralFlags

impl Eq for StringLiteralFlags

impl StructuralPartialEq for StringLiteralFlags