Struct sourceview4::SpaceLocationFlags
source · pub struct SpaceLocationFlags(/* private fields */);
Expand description
SpaceLocationFlags
contains flags for white space locations.
If a line contains only white spaces (no text), the white spaces match both
LEADING
and TRAILING
.
Implementations§
source§impl SpaceLocationFlags
impl SpaceLocationFlags
sourcepub const INSIDE_TEXT: Self = _
pub const INSIDE_TEXT: Self = _
White spaces inside a line of text.
source§impl SpaceLocationFlags
impl SpaceLocationFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
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.
sourcepub const fn contains(&self, other: Self) -> bool
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.
sourcepub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl SpaceLocationFlags
impl SpaceLocationFlags
sourcepub const fn iter(&self) -> Iter<SpaceLocationFlags>
pub const fn iter(&self) -> Iter<SpaceLocationFlags>
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.
sourcepub const fn iter_names(&self) -> IterNames<SpaceLocationFlags>
pub const fn iter_names(&self) -> IterNames<SpaceLocationFlags>
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§
source§impl Binary for SpaceLocationFlags
impl Binary for SpaceLocationFlags
source§impl BitAnd for SpaceLocationFlags
impl BitAnd for SpaceLocationFlags
source§impl BitAndAssign for SpaceLocationFlags
impl BitAndAssign for SpaceLocationFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for SpaceLocationFlags
impl BitOr for SpaceLocationFlags
source§fn bitor(self, other: SpaceLocationFlags) -> Self
fn bitor(self, other: SpaceLocationFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = SpaceLocationFlags
type Output = SpaceLocationFlags
|
operator.source§impl BitOrAssign for SpaceLocationFlags
impl BitOrAssign for SpaceLocationFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for SpaceLocationFlags
impl BitXor for SpaceLocationFlags
source§impl BitXorAssign for SpaceLocationFlags
impl BitXorAssign for SpaceLocationFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for SpaceLocationFlags
impl Clone for SpaceLocationFlags
source§fn clone(&self) -> SpaceLocationFlags
fn clone(&self) -> SpaceLocationFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SpaceLocationFlags
impl Debug for SpaceLocationFlags
source§impl Display for SpaceLocationFlags
impl Display for SpaceLocationFlags
source§impl Extend<SpaceLocationFlags> for SpaceLocationFlags
impl Extend<SpaceLocationFlags> for SpaceLocationFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
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 Flags for SpaceLocationFlags
impl Flags for SpaceLocationFlags
source§const FLAGS: &'static [Flag<SpaceLocationFlags>] = _
const FLAGS: &'static [Flag<SpaceLocationFlags>] = _
source§fn from_bits_retain(bits: u32) -> SpaceLocationFlags
fn from_bits_retain(bits: u32) -> SpaceLocationFlags
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl From<SpaceLocationFlags> for Value
impl From<SpaceLocationFlags> for Value
source§fn from(v: SpaceLocationFlags) -> Self
fn from(v: SpaceLocationFlags) -> Self
source§impl FromIterator<SpaceLocationFlags> for SpaceLocationFlags
impl FromIterator<SpaceLocationFlags> for SpaceLocationFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl<'a> FromValue<'a> for SpaceLocationFlags
impl<'a> FromValue<'a> for SpaceLocationFlags
§type Checker = GenericValueTypeChecker<SpaceLocationFlags>
type Checker = GenericValueTypeChecker<SpaceLocationFlags>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for SpaceLocationFlags
impl HasParamSpec for SpaceLocationFlags
type ParamSpec = ParamSpecFlags
§type SetValue = SpaceLocationFlags
type SetValue = SpaceLocationFlags
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, SpaceLocationFlags>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for SpaceLocationFlags
impl Hash for SpaceLocationFlags
source§impl IntoIterator for SpaceLocationFlags
impl IntoIterator for SpaceLocationFlags
source§impl LowerHex for SpaceLocationFlags
impl LowerHex for SpaceLocationFlags
source§impl Not for SpaceLocationFlags
impl Not for SpaceLocationFlags
source§impl Octal for SpaceLocationFlags
impl Octal for SpaceLocationFlags
source§impl PartialEq for SpaceLocationFlags
impl PartialEq for SpaceLocationFlags
source§fn eq(&self, other: &SpaceLocationFlags) -> bool
fn eq(&self, other: &SpaceLocationFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for SpaceLocationFlags
impl PublicFlags for SpaceLocationFlags
source§impl StaticType for SpaceLocationFlags
impl StaticType for SpaceLocationFlags
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub for SpaceLocationFlags
impl Sub for SpaceLocationFlags
source§fn sub(self, other: Self) -> Self
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 = SpaceLocationFlags
type Output = SpaceLocationFlags
-
operator.source§impl SubAssign for SpaceLocationFlags
impl SubAssign for SpaceLocationFlags
source§fn sub_assign(&mut self, other: Self)
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.
source§impl ToValue for SpaceLocationFlags
impl ToValue for SpaceLocationFlags
source§impl UpperHex for SpaceLocationFlags
impl UpperHex for SpaceLocationFlags
source§impl ValueType for SpaceLocationFlags
impl ValueType for SpaceLocationFlags
§type Type = SpaceLocationFlags
type Type = SpaceLocationFlags
Type
from. Read moreimpl Copy for SpaceLocationFlags
impl Eq for SpaceLocationFlags
impl StructuralEq for SpaceLocationFlags
impl StructuralPartialEq for SpaceLocationFlags
Auto Trait Implementations§
impl RefUnwindSafe for SpaceLocationFlags
impl Send for SpaceLocationFlags
impl Sync for SpaceLocationFlags
impl Unpin for SpaceLocationFlags
impl UnwindSafe for SpaceLocationFlags
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
source§impl<T> IntoClosureReturnValue for T
impl<T> IntoClosureReturnValue for T
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere
T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere
T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for T
impl<T> ToSendValue for T
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.