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 fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl ListFormat

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 = _

impl ListFormat

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 = _

impl ListFormat

pub const AllowTrailingComma: Self = _

Write a trailing comma (“,”) if present.

impl ListFormat

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.

impl ListFormat

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 = _

impl ListFormat

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 = _

impl ListFormat

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 = _

impl ListFormat

pub const CanSkipTrailingComma: Self = _

impl ListFormat

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 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

Returns the intersection between the two sets of flags.

type Output = ListFormat

The resulting type after applying the & operator.

impl BitAndAssign for ListFormat

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for ListFormat

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

Returns the union of the two sets of flags.

type Output = ListFormat

The resulting type after applying the | operator.

impl BitOrAssign for ListFormat

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for ListFormat

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

Returns the left flags, but with all the right flags toggled.

type Output = ListFormat

The resulting type after applying the ^ operator.

impl BitXorAssign for ListFormat

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

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 Debug for ListFormat

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

Formats the value using the given formatter.

impl Extend<ListFormat> for ListFormat

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

Extends a collection with the contents of an iterator.

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 FromIterator<ListFormat> for ListFormat

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

Creates a value from an iterator.

impl Hash for ListFormat

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 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

Returns the complement of this set of flags.

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 Ord for ListFormat

fn cmp(&self, other: &ListFormat) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for ListFormat

fn partial_cmp(&self, other: &ListFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for ListFormat

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

Returns the set difference of the two sets of flags.

type Output = ListFormat

The resulting type after applying the - operator.

impl SubAssign for ListFormat

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

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