Struct gdal::GdalOpenFlags
source · pub struct GdalOpenFlags(_);
Expand description
GDal extended open flags used by Dataset::open_ex
.
Used in the nOpenFlags
argument to GDALOpenEx
.
Note that the GDAL_OF_SHARED
option is removed
from the set of allowed option because it subverts
the Send
implementation that allow passing the
dataset the another thread. See
https://github.com/georust/gdal/issues/154.
Implementations§
source§impl GdalOpenFlags
impl GdalOpenFlags
sourcepub const GDAL_OF_READONLY: Self = _
pub const GDAL_OF_READONLY: Self = _
Open in read-only mode (default).
sourcepub const GDAL_OF_UPDATE: Self = _
pub const GDAL_OF_UPDATE: Self = _
Open in update mode.
sourcepub const GDAL_OF_ALL: Self = _
pub const GDAL_OF_ALL: Self = _
Allow raster and vector drivers to be used.
sourcepub const GDAL_OF_RASTER: Self = _
pub const GDAL_OF_RASTER: Self = _
Allow raster drivers to be used.
sourcepub const GDAL_OF_VECTOR: Self = _
pub const GDAL_OF_VECTOR: Self = _
Allow vector drivers to be used.
sourcepub const GDAL_OF_GNM: Self = _
pub const GDAL_OF_GNM: Self = _
Allow gnm drivers to be used.
sourcepub const GDAL_OF_MULTIDIM_RASTER: Self = _
pub const GDAL_OF_MULTIDIM_RASTER: Self = _
Allow multidimensional raster drivers to be used.
sourcepub const GDAL_OF_VERBOSE_ERROR: Self = _
pub const GDAL_OF_VERBOSE_ERROR: Self = _
Emit error message in case of failed open.
sourcepub const GDAL_OF_INTERNAL: Self = _
pub const GDAL_OF_INTERNAL: Self = _
Open as internal dataset. Such dataset isn’t registered in the global list of opened dataset. Cannot be used with GDAL_OF_SHARED.
sourcepub const GDAL_OF_DEFAULT_BLOCK_ACCESS: Self = _
pub const GDAL_OF_DEFAULT_BLOCK_ACCESS: Self = _
Default strategy for cached blocks.
sourcepub const GDAL_OF_ARRAY_BLOCK_ACCESS: Self = _
pub const GDAL_OF_ARRAY_BLOCK_ACCESS: Self = _
Array based strategy for cached blocks.
sourcepub const GDAL_OF_HASHSET_BLOCK_ACCESS: Self = _
pub const GDAL_OF_HASHSET_BLOCK_ACCESS: Self = _
Hashset based strategy for cached blocks.
source§impl GdalOpenFlags
impl GdalOpenFlags
sourcepub const fn bits(&self) -> c_uint
pub const fn bits(&self) -> c_uint
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: c_uint) -> Option<Self>
pub const fn from_bits(bits: c_uint) -> 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: c_uint) -> Self
pub const fn from_bits_truncate(bits: c_uint) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: c_uint) -> Self
pub const fn from_bits_retain(bits: c_uint) -> 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 GdalOpenFlags
impl GdalOpenFlags
sourcepub const fn iter(&self) -> Iter<GdalOpenFlags>
pub const fn iter(&self) -> Iter<GdalOpenFlags>
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<GdalOpenFlags>
pub const fn iter_names(&self) -> IterNames<GdalOpenFlags>
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 GdalOpenFlags
impl Binary for GdalOpenFlags
source§impl BitAnd<GdalOpenFlags> for GdalOpenFlags
impl BitAnd<GdalOpenFlags> for GdalOpenFlags
source§impl BitAndAssign<GdalOpenFlags> for GdalOpenFlags
impl BitAndAssign<GdalOpenFlags> for GdalOpenFlags
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<GdalOpenFlags> for GdalOpenFlags
impl BitOr<GdalOpenFlags> for GdalOpenFlags
source§fn bitor(self, other: GdalOpenFlags) -> Self
fn bitor(self, other: GdalOpenFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = GdalOpenFlags
type Output = GdalOpenFlags
|
operator.source§impl BitOrAssign<GdalOpenFlags> for GdalOpenFlags
impl BitOrAssign<GdalOpenFlags> for GdalOpenFlags
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<GdalOpenFlags> for GdalOpenFlags
impl BitXor<GdalOpenFlags> for GdalOpenFlags
source§impl BitXorAssign<GdalOpenFlags> for GdalOpenFlags
impl BitXorAssign<GdalOpenFlags> for GdalOpenFlags
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 Debug for GdalOpenFlags
impl Debug for GdalOpenFlags
source§impl Default for GdalOpenFlags
impl Default for GdalOpenFlags
source§fn default() -> GdalOpenFlags
fn default() -> GdalOpenFlags
source§impl Extend<GdalOpenFlags> for GdalOpenFlags
impl Extend<GdalOpenFlags> for GdalOpenFlags
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 GdalOpenFlags
impl Flags for GdalOpenFlags
source§const FLAGS: &'static [Flag<GdalOpenFlags>] = _
const FLAGS: &'static [Flag<GdalOpenFlags>] = _
source§fn from_bits_retain(bits: c_uint) -> GdalOpenFlags
fn from_bits_retain(bits: c_uint) -> GdalOpenFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
source§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.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
&!
). Read moresource§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.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl From<u32> for GdalOpenFlags
impl From<u32> for GdalOpenFlags
source§fn from(val: Type) -> GdalOpenFlags
fn from(val: Type) -> GdalOpenFlags
source§impl FromIterator<GdalOpenFlags> for GdalOpenFlags
impl FromIterator<GdalOpenFlags> for GdalOpenFlags
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 IntoIterator for GdalOpenFlags
impl IntoIterator for GdalOpenFlags
source§impl LowerHex for GdalOpenFlags
impl LowerHex for GdalOpenFlags
source§impl Not for GdalOpenFlags
impl Not for GdalOpenFlags
source§impl Octal for GdalOpenFlags
impl Octal for GdalOpenFlags
source§impl PublicFlags for GdalOpenFlags
impl PublicFlags for GdalOpenFlags
source§impl Sub<GdalOpenFlags> for GdalOpenFlags
impl Sub<GdalOpenFlags> for GdalOpenFlags
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 = GdalOpenFlags
type Output = GdalOpenFlags
-
operator.source§impl SubAssign<GdalOpenFlags> for GdalOpenFlags
impl SubAssign<GdalOpenFlags> for GdalOpenFlags
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.