Struct polars::chunked_array::Settings
source · pub struct Settings(/* private fields */);
Implementations§
source§impl Settings
impl Settings
pub const SORTED_ASC: Settings = _
pub const SORTED_DSC: Settings = _
pub const FAST_EXPLODE_LIST: Settings = _
source§impl Settings
impl Settings
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Settings>
pub const fn from_bits(bits: u8) -> Option<Settings>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> Settings
pub const fn from_bits_truncate(bits: u8) -> Settings
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Settings
pub const fn from_bits_retain(bits: u8) -> Settings
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Settings>
pub fn from_name(name: &str) -> Option<Settings>
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: Settings) -> bool
pub const fn intersects(&self, other: Settings) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Settings) -> bool
pub const fn contains(&self, other: Settings) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Settings)
pub fn remove(&mut self, other: Settings)
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: Settings)
pub fn toggle(&mut self, other: Settings)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Settings, value: bool)
pub fn set(&mut self, other: Settings, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Settings) -> Settings
pub const fn intersection(self, other: Settings) -> Settings
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Settings) -> Settings
pub const fn union(self, other: Settings) -> Settings
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Settings) -> Settings
pub const fn difference(self, other: Settings) -> Settings
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: Settings) -> Settings
pub const fn symmetric_difference(self, other: Settings) -> Settings
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Settings
pub const fn complement(self) -> Settings
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl Settings
impl Settings
sourcepub const fn iter(&self) -> Iter<Settings>
pub const fn iter(&self) -> Iter<Settings>
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<Settings>
pub const fn iter_names(&self) -> IterNames<Settings>
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.
source§impl Settings
impl Settings
pub fn set_sorted_flag(&mut self, sorted: IsSorted)
pub fn get_sorted_flag(&self) -> IsSorted
Trait Implementations§
source§impl BitAndAssign for Settings
impl BitAndAssign for Settings
source§fn bitand_assign(&mut self, other: Settings)
fn bitand_assign(&mut self, other: Settings)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign for Settings
impl BitOrAssign for Settings
source§fn bitor_assign(&mut self, other: Settings)
fn bitor_assign(&mut self, other: Settings)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign for Settings
impl BitXorAssign for Settings
source§fn bitxor_assign(&mut self, other: Settings)
fn bitxor_assign(&mut self, other: Settings)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Extend<Settings> for Settings
impl Extend<Settings> for Settings
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Settings>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Settings>,
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 Settings
impl Flags for Settings
source§fn from_bits_retain(bits: u8) -> Settings
fn from_bits_retain(bits: u8) -> Settings
§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 FromIterator<Settings> for Settings
impl FromIterator<Settings> for Settings
source§impl IntoIterator for Settings
impl IntoIterator for Settings
source§impl PartialEq for Settings
impl PartialEq for Settings
source§impl Sub for Settings
impl Sub for Settings
source§impl SubAssign for Settings
impl SubAssign for Settings
source§fn sub_assign(&mut self, other: Settings)
fn sub_assign(&mut self, other: Settings)
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 Copy for Settings
impl StructuralPartialEq for Settings
Auto Trait Implementations§
impl Freeze for Settings
impl RefUnwindSafe for Settings
impl Send for Settings
impl Sync for Settings
impl Unpin for Settings
impl UnwindSafe for Settings
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<A, T, E> FromFallibleIterator<A, E> for Twhere
T: FromIterator<A>,
E: Error,
impl<A, T, E> FromFallibleIterator<A, E> for Twhere
T: FromIterator<A>,
E: Error,
fn from_fallible_iter<F>(iter: F) -> Result<T, E>where
F: FallibleIterator<E, Item = A>,
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