Struct srclang::compiler::text::SpanOverlap
pub struct SpanOverlap(/* private fields */);
Implementations
impl SpanOverlap
pub const NONE: Self = _
pub const START: Self = _
pub const END: Self = _
pub const BOTH: Self = _
impl SpanOverlap
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) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u8) -> 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 SpanOverlap
pub const fn iter(&self) -> Iter<SpanOverlap>
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<SpanOverlap>
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.
Trait Implementations
impl Binary for SpanOverlap
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
impl BitAnd for SpanOverlap
fn bitand(self, other: Self) -> Self
The bitwise and ( &
) of the bits in two flags values.
type Output = SpanOverlap
The resulting type after applying the &
operator.
impl BitAndAssign for SpanOverlap
fn bitand_assign(&mut self, other: Self)
The bitwise and ( &
) of the bits in two flags values.
impl BitOr for SpanOverlap
fn bitor(self, other: SpanOverlap) -> Self
The bitwise or ( |
) of the bits in two flags values.
type Output = SpanOverlap
The resulting type after applying the |
operator.
impl BitOrAssign for SpanOverlap
fn bitor_assign(&mut self, other: Self)
The bitwise or ( |
) of the bits in two flags values.
impl BitXor for SpanOverlap
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or ( ^
) of the bits in two flags values.
type Output = SpanOverlap
The resulting type after applying the ^
operator.
impl BitXorAssign for SpanOverlap
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or ( ^
) of the bits in two flags values.
impl Clone for SpanOverlap
fn clone(&self) -> SpanOverlap
Returns a copy of the value. Read more1.0.0 ·
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for SpanOverlap
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl Extend<SpanOverlap> for SpanOverlap
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. Read more
impl Flags for SpanOverlap
const FLAGS: &'static [Flag<SpanOverlap>] = _
The set of defined flags.
type Bits = u8
The underlying bits type.
fn bits(&self) -> u8
Get the underlying bits value. Read more
fn from_bits_retain(bits: u8) -> SpanOverlap
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 from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
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. Read more
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
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) -> boolwhere Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
fn contains(&self, other: Self) -> boolwhere Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
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 (&!
). Read more
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 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 (&!
). Read more
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<SpanOverlap> for SpanOverlap
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or ( |
) of the bits in each flags value.
impl Hash for SpanOverlap
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher
. Read more1.3.0 ·
fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,
Feeds a slice of this type into the given Hasher
. Read more
impl IntoIterator for SpanOverlap
type Item = SpanOverlap
The type of the elements being iterated over.
type IntoIter = Iter<SpanOverlap>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
impl LowerHex for SpanOverlap
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
impl Not for SpanOverlap
fn not(self) -> Self
The bitwise negation ( !
) of the bits in a flags value, truncating the result.
type Output = SpanOverlap
The resulting type after applying the !
operator.
impl Octal for SpanOverlap
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
impl Ord for SpanOverlap
fn cmp(&self, other: &SpanOverlap) -> Ordering
This method returns an Ordering
between self
and other
. Read more1.21.0 ·
fn max(self, other: Self) -> Selfwhere Self: Sized,
Compares and returns the maximum of two values. Read more1.21.0 ·
fn min(self, other: Self) -> Selfwhere Self: Sized,
Compares and returns the minimum of two values. Read more1.50.0 ·
fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,
Restrict a value to a certain interval. Read more
impl PartialEq for SpanOverlap
fn eq(&self, other: &SpanOverlap) -> bool
This method tests for self
and other
values to be equal, and is used by ==
.1.0.0 ·
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
. The default implementation is almost always sufficient, and should not be overridden without very good reason.
impl PartialOrd for SpanOverlap
fn partial_cmp(&self, other: &SpanOverlap) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more1.0.0 ·
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more1.0.0 ·
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more1.0.0 ·
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more1.0.0 ·
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl PublicFlags for SpanOverlap
type Primitive = u8
The type of the underlying storage.
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
impl Sub for SpanOverlap
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 = SpanOverlap
The resulting type after applying the -
operator.
impl SubAssign for SpanOverlap
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 SpanOverlap
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
impl Copy for SpanOverlap
impl Eq for SpanOverlap
impl StructuralPartialEq for SpanOverlap
Auto Trait Implementations
impl Freeze for SpanOverlap
impl RefUnwindSafe for SpanOverlap
impl Send for SpanOverlap
impl Sync for SpanOverlap
impl Unpin for SpanOverlap
impl UnwindSafe for SpanOverlap
Blanket Implementations
impl<T> Any for Twhere T: 'static + ?Sized,
fn type_id(&self) -> TypeId
Gets the TypeId
of self
. Read more
impl<T> Borrow<T> for Twhere T: ?Sized,
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T> BorrowMut<T> for Twhere T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,
fn compare(&self, key: &K) -> Ordering
Compare self to key
and return their ordering.
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
impl<T> From<T> for T
fn from(t: T) -> T
Returns the argument unchanged.
impl<T, U> Into<U> for Twhere U: From<T>,
fn into(self) -> U
Calls U::from(self)
.
That is, this conversion is whatever the implementation of From<T> for U
chooses to do.
impl<T> Pointable for T
const ALIGN: usize = _
The alignment of pointer.
type Init = T
The type for initializers.
unsafe fn init(init: <T as Pointable>::Init) -> usize
Initializes a with the given initializer. Read more
unsafe fn deref<'a>(ptr: usize) -> &'a T
Dereferences the given pointer. Read more
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
Mutably dereferences the given pointer. Read more
unsafe fn drop(ptr: usize)
Drops the object pointed to by the given pointer. Read more
impl<T> ToOwned for Twhere T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T, U> TryFrom<U> for Twhere U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.