Struct ListFormat

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

Represents the formatting rule for a list of nodes.

Implementations

impl ListFormat

pub const None: Self

Default value.

pub const SingleLine: Self

Prints the list on a single line (default).

pub const MultiLine: Self

Prints the list on multiple lines.

pub const PreserveLines: Self

Prints the list using line preservation if possible.

pub const LinesMask: Self

pub const NotDelimited: Self

There is no delimiter between list items (default).

pub const BarDelimited: Self

Each list item is space-and-bar (“ |“) delimited.

pub const AmpersandDelimited: Self

Each list item is space-and-ampersand (“ &“) delimited.

pub const CommaDelimited: Self

Each list item is comma (“;”) delimited.

pub const DelimitersMask: Self

pub const AllowTrailingComma: Self

pub const Indented: Self

The list should be indented.

pub const SpaceBetweenBraces: Self

Inserts a space after the opening brace and before the closing brace.

pub const SpaceBetweenSiblings: Self

Inserts a space between each sibling node.

pub const Braces: Self

The list is surrounded by “{” and “}”.

pub const Parenthesis: Self

The list is surrounded by “(” and “)”.

pub const AngleBrackets: Self

The list is surrounded by “<” and “>”.

pub const SquareBrackets: Self

The list is surrounded by “[” and “]”.

pub const BracketsMask: Self

pub const OptionalIfUndefined: Self

Do not emit brackets if the list is undefined.

pub const OptionalIfEmpty: Self

Do not emit brackets if the list is empty.

pub const Optional: Self

pub const PreferNewLine: Self

Prefer adding a LineTerminator between synthesized nodes.

pub const NoTrailingNewLine: Self

Do not emit a trailing NewLine for a MultiLine list.

pub const NoInterveningComments: Self

Do not emit comments between each node

pub const NoSpaceIfEmpty: Self

If the literal is empty; do not add spaces between braces.

pub const SingleElement: Self

pub const ForceTrailingComma: Self

pub const CanSkipTrailingComma: Self

pub const Modifiers: Self

pub const HeritageClauses: Self

pub const SingleLineTypeLiteralMembers: Self

pub const MultiLineTypeLiteralMembers: Self

pub const TupleTypeElements: Self

pub const UnionTypeConstituents: Self

pub const IntersectionTypeConstituents: Self

pub const ObjectBindingPatternElements: Self

pub const ArrayBindingPatternElements: Self

pub const ObjectLiteralExpressionProperties: Self

pub const ArrayLiteralExpressionElements: Self

pub const CommaListElements: Self

pub const CallExpressionArguments: Self

pub const NewExpressionArguments: Self

pub const TemplateExpressionSpans: Self

pub const SingleLineBlockStatements: Self

pub const MultiLineBlockStatements: Self

pub const VariableDeclarationList: Self

pub const SingleLineFunctionBodyStatements: Self

pub const MultiLineFunctionBodyStatements: Self

pub const ClassHeritageClauses: Self

pub const ClassMembers: Self

pub const InterfaceMembers: Self

pub const EnumMembers: Self

pub const CaseBlockClauses: Self

pub const NamedImportsOrExportsElements: Self

pub const JsxElementOrFragmentChildren: Self

pub const JsxElementAttributes: Self

pub const CaseOrDefaultClauseStatements: Self

pub const HeritageClauseTypes: Self

pub const SourceFileStatements: Self

pub const Decorators: Self

pub const TypeArguments: Self

pub const TypeParameters: Self

pub const Parameters: Self

pub const IndexSignatureParameters: Self

impl ListFormat

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ListFormat

pub const fn iter(&self) -> Iter<ListFormat>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ListFormat>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl ListFormat

pub fn opening_bracket(self) -> &'static str

pub fn closing_bracket(self) -> &'static str

Trait Implementations

impl Binary for ListFormat

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

Formats the value using the given formatter.

impl BitAnd for ListFormat

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = ListFormat

The resulting type after applying the & operator.

impl BitAndAssign for ListFormat

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ListFormat

fn bitor(self, other: ListFormat) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = ListFormat

The resulting type after applying the | operator.

impl BitOrAssign for ListFormat

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ListFormat

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ListFormat

The resulting type after applying the ^ operator.

impl BitXorAssign for ListFormat

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ListFormat

fn clone(&self) -> ListFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<ListFormat> for ListFormat

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ListFormat

const FLAGS: &'static [Flag<ListFormat>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ListFormat

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ListFormat> for ListFormat

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for ListFormat

type Item = ListFormat

The type of the elements being iterated over.

type IntoIter = Iter<ListFormat>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ListFormat

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

Formats the value using the given formatter.

impl Not for ListFormat

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ListFormat

The resulting type after applying the ! operator.

impl Octal for ListFormat

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

Formats the value using the given formatter.

impl PartialEq for ListFormat

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

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for ListFormat

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ListFormat

The resulting type after applying the - operator.

impl SubAssign for ListFormat

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ListFormat

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

Formats the value using the given formatter.

impl Copy for ListFormat

impl Eq for ListFormat

impl StructuralPartialEq for ListFormat