Struct openssh_sftp_client::Permissions
source · [−]pub struct Permissions { /* private fields */ }
Implementations
sourceimpl Permissions
impl Permissions
sourcepub const SET_UID: Permissions
pub const SET_UID: Permissions
set-user-ID (set process effective user ID on execve(2))
sourcepub const SET_GID: Permissions
pub const SET_GID: Permissions
set-group-ID
- set process effective group ID on execve(2)
- mandatory locking, as described in fcntl(2)
- take a new file’s group from parent directory, as described in chown(2) and mkdir(2)
sourcepub const SET_VTX: Permissions
pub const SET_VTX: Permissions
sticky bit (restricted deletion flag, as described in unlink(2))
sourcepub const READ_BY_OWNER: Permissions
pub const READ_BY_OWNER: Permissions
read by owner
sourcepub const WRITE_BY_OWNER: Permissions
pub const WRITE_BY_OWNER: Permissions
write by owner
sourcepub const EXECUTE_BY_OWNER: Permissions
pub const EXECUTE_BY_OWNER: Permissions
execute file or search directory by owner
sourcepub const READ_BY_GROUP: Permissions
pub const READ_BY_GROUP: Permissions
read by group
sourcepub const WRITE_BY_GROUP: Permissions
pub const WRITE_BY_GROUP: Permissions
write by group
sourcepub const EXECUTE_BY_GROUP: Permissions
pub const EXECUTE_BY_GROUP: Permissions
execute/search by group
sourcepub const READ_BY_OTHER: Permissions
pub const READ_BY_OTHER: Permissions
read by others
sourcepub const WRITE_BY_OTHER: Permissions
pub const WRITE_BY_OTHER: Permissions
write by others
sourcepub const EXECUTE_BY_OTHER: Permissions
pub const EXECUTE_BY_OTHER: Permissions
execute/search by others
sourcepub const fn empty() -> Permissions
pub const fn empty() -> Permissions
Returns an empty set of flags.
sourcepub const fn all() -> Permissions
pub const fn all() -> Permissions
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<Permissions>
pub const fn from_bits(bits: u32) -> Option<Permissions>
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) -> Permissions
pub const fn from_bits_truncate(bits: u32) -> Permissions
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Permissions
pub const unsafe fn from_bits_unchecked(bits: u32) -> Permissions
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: Permissions) -> bool
pub const fn intersects(&self, other: Permissions) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Permissions) -> bool
pub const fn contains(&self, other: Permissions) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: Permissions)
pub fn insert(&mut self, other: Permissions)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: Permissions)
pub fn remove(&mut self, other: Permissions)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: Permissions)
pub fn toggle(&mut self, other: Permissions)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: Permissions, value: bool)
pub fn set(&mut self, other: Permissions, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Permissions) -> Permissions
pub const fn intersection(self, other: Permissions) -> Permissions
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: Permissions) -> Permissions
pub const fn union(self, other: Permissions) -> Permissions
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: Permissions) -> Permissions
pub const fn difference(self, other: Permissions) -> Permissions
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: Permissions) -> Permissions
pub const fn symmetric_difference(self, other: Permissions) -> Permissions
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) -> Permissions
pub const fn complement(self) -> Permissions
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
.
Trait Implementations
sourceimpl Binary for Permissions
impl Binary for Permissions
sourceimpl BitAnd<Permissions> for Permissions
impl BitAnd<Permissions> for Permissions
sourcepub fn bitand(self, other: Permissions) -> Permissions
pub fn bitand(self, other: Permissions) -> Permissions
Returns the intersection between the two sets of flags.
type Output = Permissions
type Output = Permissions
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<Permissions> for Permissions
impl BitAndAssign<Permissions> for Permissions
sourcepub fn bitand_assign(&mut self, other: Permissions)
pub fn bitand_assign(&mut self, other: Permissions)
Disables all flags disabled in the set.
sourceimpl BitOr<Permissions> for Permissions
impl BitOr<Permissions> for Permissions
sourcepub fn bitor(self, other: Permissions) -> Permissions
pub fn bitor(self, other: Permissions) -> Permissions
Returns the union of the two sets of flags.
type Output = Permissions
type Output = Permissions
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<Permissions> for Permissions
impl BitOrAssign<Permissions> for Permissions
sourcepub fn bitor_assign(&mut self, other: Permissions)
pub fn bitor_assign(&mut self, other: Permissions)
Adds the set of flags.
sourceimpl BitXor<Permissions> for Permissions
impl BitXor<Permissions> for Permissions
sourcepub fn bitxor(self, other: Permissions) -> Permissions
pub fn bitxor(self, other: Permissions) -> Permissions
Returns the left flags, but with all the right flags toggled.
type Output = Permissions
type Output = Permissions
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<Permissions> for Permissions
impl BitXorAssign<Permissions> for Permissions
sourcepub fn bitxor_assign(&mut self, other: Permissions)
pub fn bitxor_assign(&mut self, other: Permissions)
Toggles the set of flags.
sourceimpl Clone for Permissions
impl Clone for Permissions
sourcepub fn clone(&self) -> Permissions
pub fn clone(&self) -> Permissions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for Permissions
impl Debug for Permissions
sourceimpl Default for Permissions
impl Default for Permissions
sourcepub fn default() -> Permissions
pub fn default() -> Permissions
Returns the “default value” for a type. Read more
sourceimpl Extend<Permissions> for Permissions
impl Extend<Permissions> for Permissions
sourcepub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = Permissions>,
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = Permissions>,
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<Permissions> for Permissions
impl FromIterator<Permissions> for Permissions
sourcepub fn from_iter<T>(iterator: T) -> Permissions where
T: IntoIterator<Item = Permissions>,
pub fn from_iter<T>(iterator: T) -> Permissions where
T: IntoIterator<Item = Permissions>,
Creates a value from an iterator. Read more
sourceimpl Hash for Permissions
impl Hash for Permissions
sourceimpl LowerHex for Permissions
impl LowerHex for Permissions
sourceimpl Not for Permissions
impl Not for Permissions
sourcepub fn not(self) -> Permissions
pub fn not(self) -> Permissions
Returns the complement of this set of flags.
type Output = Permissions
type Output = Permissions
The resulting type after applying the !
operator.
sourceimpl Octal for Permissions
impl Octal for Permissions
sourceimpl Ord for Permissions
impl Ord for Permissions
sourceimpl PartialEq<Permissions> for Permissions
impl PartialEq<Permissions> for Permissions
sourcepub fn eq(&self, other: &Permissions) -> bool
pub fn eq(&self, other: &Permissions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcepub fn ne(&self, other: &Permissions) -> bool
pub fn ne(&self, other: &Permissions) -> bool
This method tests for !=
.
sourceimpl PartialOrd<Permissions> for Permissions
impl PartialOrd<Permissions> for Permissions
sourcepub fn partial_cmp(&self, other: &Permissions) -> Option<Ordering>
pub fn partial_cmp(&self, other: &Permissions) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
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 more
sourceimpl Sub<Permissions> for Permissions
impl Sub<Permissions> for Permissions
sourcepub fn sub(self, other: Permissions) -> Permissions
pub fn sub(self, other: Permissions) -> Permissions
Returns the set difference of the two sets of flags.
type Output = Permissions
type Output = Permissions
The resulting type after applying the -
operator.
sourceimpl SubAssign<Permissions> for Permissions
impl SubAssign<Permissions> for Permissions
sourcepub fn sub_assign(&mut self, other: Permissions)
pub fn sub_assign(&mut self, other: Permissions)
Disables all flags enabled in the set.
sourceimpl UpperHex for Permissions
impl UpperHex for Permissions
impl Copy for Permissions
impl Eq for Permissions
impl StructuralEq for Permissions
impl StructuralPartialEq for Permissions
Auto Trait Implementations
impl RefUnwindSafe for Permissions
impl Send for Permissions
impl Sync for Permissions
impl Unpin for Permissions
impl UnwindSafe for Permissions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more