pub struct ListFormat { /* private fields */ }
Expand description
Represents the formatting rule for a list of nodes.
Implementations§
source§impl ListFormat
impl ListFormat
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
.
source§impl ListFormat
impl ListFormat
sourcepub const SingleLine: Self = _
pub const SingleLine: Self = _
Prints the list on a single line (default).
sourcepub const PreserveLines: Self = _
pub const PreserveLines: Self = _
Prints the list using line preservation if possible.
pub const LinesMask: Self = _
source§impl ListFormat
impl ListFormat
sourcepub const NotDelimited: Self = _
pub const NotDelimited: Self = _
There is no delimiter between list items (default).
sourcepub const BarDelimited: Self = _
pub const BarDelimited: Self = _
Each list item is space-and-bar (“ |“) delimited.
sourcepub const AmpersandDelimited: Self = _
pub const AmpersandDelimited: Self = _
Each list item is space-and-ampersand (“ &“) delimited.
sourcepub const CommaDelimited: Self = _
pub const CommaDelimited: Self = _
Each list item is comma (“,”) delimited.
pub const DelimitersMask: Self = _
source§impl ListFormat
impl ListFormat
sourcepub const AllowTrailingComma: Self = _
pub const AllowTrailingComma: Self = _
Write a trailing comma (“,”) if present.
source§impl ListFormat
impl ListFormat
sourcepub const SpaceBetweenBraces: Self = _
pub const SpaceBetweenBraces: Self = _
Inserts a space after the opening brace and before the closing brace.
sourcepub const SpaceBetweenSiblings: Self = _
pub const SpaceBetweenSiblings: Self = _
Inserts a space between each sibling node.
source§impl ListFormat
impl ListFormat
sourcepub const Parenthesis: Self = _
pub const Parenthesis: Self = _
The list is surrounded by “(” and “)”.
sourcepub const AngleBrackets: Self = _
pub const AngleBrackets: Self = _
The list is surrounded by “<” and “>”.
sourcepub const SquareBrackets: Self = _
pub const SquareBrackets: Self = _
The list is surrounded by “[” and “]”.
pub const BracketsMask: Self = _
source§impl ListFormat
impl ListFormat
sourcepub const OptionalIfUndefined: Self = _
pub const OptionalIfUndefined: Self = _
Do not emit brackets if the list is undefined.
sourcepub const OptionalIfEmpty: Self = _
pub const OptionalIfEmpty: Self = _
Do not emit brackets if the list is empty.
pub const Optional: Self = _
source§impl ListFormat
impl ListFormat
sourcepub const PreferNewLine: Self = _
pub const PreferNewLine: Self = _
Prefer adding a LineTerminator between synthesized nodes.
sourcepub const NoTrailingNewLine: Self = _
pub const NoTrailingNewLine: Self = _
Do not emit a trailing NewLine for a MultiLine list.
sourcepub const NoInterveningComments: Self = _
pub const NoInterveningComments: Self = _
Do not emit comments between each node
sourcepub const NoSpaceIfEmpty: Self = _
pub const NoSpaceIfEmpty: Self = _
If the literal is empty, do not add spaces between braces.
pub const SingleElement: Self = _
pub const ForceTrailingComma: Self = _
source§impl ListFormat
impl ListFormat
pub const CanSkipTrailingComma: Self = _
source§impl ListFormat
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 = _
source§impl ListFormat
impl ListFormat
pub fn opening_bracket(self) -> &'static str
pub fn closing_bracket(self) -> &'static str
Trait Implementations§
source§impl Binary for ListFormat
impl Binary for ListFormat
source§impl BitAnd for ListFormat
impl BitAnd for ListFormat
source§impl BitAndAssign for ListFormat
impl BitAndAssign for ListFormat
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for ListFormat
impl BitOr for ListFormat
source§fn bitor(self, other: ListFormat) -> Self
fn bitor(self, other: ListFormat) -> Self
Returns the union of the two sets of flags.
source§type Output = ListFormat
type Output = ListFormat
|
operator.source§impl BitOrAssign for ListFormat
impl BitOrAssign for ListFormat
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for ListFormat
impl BitXor for ListFormat
source§impl BitXorAssign for ListFormat
impl BitXorAssign for ListFormat
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ListFormat
impl Clone for ListFormat
source§fn clone(&self) -> ListFormat
fn clone(&self) -> ListFormat
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListFormat
impl Debug for ListFormat
source§impl Extend<ListFormat> for ListFormat
impl Extend<ListFormat> for ListFormat
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ListFormat> for ListFormat
impl FromIterator<ListFormat> for ListFormat
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ListFormat
impl Hash for ListFormat
source§impl LowerHex for ListFormat
impl LowerHex for ListFormat
source§impl Not for ListFormat
impl Not for ListFormat
source§impl Octal for ListFormat
impl Octal for ListFormat
source§impl Ord for ListFormat
impl Ord for ListFormat
source§fn cmp(&self, other: &ListFormat) -> Ordering
fn cmp(&self, other: &ListFormat) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for ListFormat
impl PartialEq for ListFormat
source§impl PartialOrd for ListFormat
impl PartialOrd for ListFormat
source§impl Sub for ListFormat
impl Sub for ListFormat
source§impl SubAssign for ListFormat
impl SubAssign for ListFormat
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for ListFormat
impl UpperHex for ListFormat
impl Copy for ListFormat
impl Eq for ListFormat
impl StructuralPartialEq for ListFormat
Auto Trait Implementations§
impl Freeze for ListFormat
impl RefUnwindSafe for ListFormat
impl Send for ListFormat
impl Sync for ListFormat
impl Unpin for ListFormat
impl UnwindSafe for ListFormat
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> CallHasher for T
impl<T> CallHasher for T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more