[−][src]Struct ssh2::OpenFlags
Options that can be used to configure how a file is opened
Implementations
impl OpenFlags
[src]
pub const READ: OpenFlags
[src]
Open the file for reading.
pub const WRITE: OpenFlags
[src]
Open the file for writing. If both this and Read
are specified,
the file is opened for both reading and writing.
pub const APPEND: OpenFlags
[src]
Force all writes to append data at the end of the file.
pub const CREATE: OpenFlags
[src]
If this flag is specified, then a new file will be created if one
does not already exist (if Truncate
is specified, the new file
will be truncated to zero length if it previously exists).
pub const TRUNCATE: OpenFlags
[src]
Forces an existing file with the same name to be truncated to zero
length when creating a file by specifying Create
. Using this flag
implies the Create
flag.
pub const EXCLUSIVE: OpenFlags
[src]
Causes the request to fail if the named file already exists. Using
this flag implies the Create
flag.
pub const fn empty() -> OpenFlags
[src]
Returns an empty set of flags
pub const fn all() -> OpenFlags
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> c_ulong
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: c_ulong) -> Option<OpenFlags>
[src]
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: c_ulong) -> OpenFlags
[src]
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: c_ulong) -> OpenFlags
[src]
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: OpenFlags) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: OpenFlags) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: OpenFlags)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: OpenFlags)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: OpenFlags)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: OpenFlags, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for OpenFlags
[src]
impl BitAnd<OpenFlags> for OpenFlags
[src]
type Output = OpenFlags
The resulting type after applying the &
operator.
fn bitand(self, other: OpenFlags) -> OpenFlags
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<OpenFlags> for OpenFlags
[src]
fn bitand_assign(&mut self, other: OpenFlags)
[src]
Disables all flags disabled in the set.
impl BitOr<OpenFlags> for OpenFlags
[src]
type Output = OpenFlags
The resulting type after applying the |
operator.
fn bitor(self, other: OpenFlags) -> OpenFlags
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<OpenFlags> for OpenFlags
[src]
fn bitor_assign(&mut self, other: OpenFlags)
[src]
Adds the set of flags.
impl BitXor<OpenFlags> for OpenFlags
[src]
type Output = OpenFlags
The resulting type after applying the ^
operator.
fn bitxor(self, other: OpenFlags) -> OpenFlags
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<OpenFlags> for OpenFlags
[src]
fn bitxor_assign(&mut self, other: OpenFlags)
[src]
Toggles the set of flags.
impl Clone for OpenFlags
[src]
impl Copy for OpenFlags
[src]
impl Debug for OpenFlags
[src]
impl Eq for OpenFlags
[src]
impl Extend<OpenFlags> for OpenFlags
[src]
fn extend<T: IntoIterator<Item = OpenFlags>>(&mut self, iterator: T)
[src]
fn extend_one(&mut self, item: A)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<OpenFlags> for OpenFlags
[src]
fn from_iter<T: IntoIterator<Item = OpenFlags>>(iterator: T) -> OpenFlags
[src]
impl Hash for OpenFlags
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for OpenFlags
[src]
impl Not for OpenFlags
[src]
type Output = OpenFlags
The resulting type after applying the !
operator.
fn not(self) -> OpenFlags
[src]
Returns the complement of this set of flags.
impl Octal for OpenFlags
[src]
impl Ord for OpenFlags
[src]
fn cmp(&self, other: &OpenFlags) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<OpenFlags> for OpenFlags
[src]
impl PartialOrd<OpenFlags> for OpenFlags
[src]
fn partial_cmp(&self, other: &OpenFlags) -> Option<Ordering>
[src]
fn lt(&self, other: &OpenFlags) -> bool
[src]
fn le(&self, other: &OpenFlags) -> bool
[src]
fn gt(&self, other: &OpenFlags) -> bool
[src]
fn ge(&self, other: &OpenFlags) -> bool
[src]
impl StructuralEq for OpenFlags
[src]
impl StructuralPartialEq for OpenFlags
[src]
impl Sub<OpenFlags> for OpenFlags
[src]
type Output = OpenFlags
The resulting type after applying the -
operator.
fn sub(self, other: OpenFlags) -> OpenFlags
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<OpenFlags> for OpenFlags
[src]
fn sub_assign(&mut self, other: OpenFlags)
[src]
Disables all flags enabled in the set.
impl UpperHex for OpenFlags
[src]
Auto Trait Implementations
impl RefUnwindSafe for OpenFlags
impl Send for OpenFlags
impl Sync for OpenFlags
impl Unpin for OpenFlags
impl UnwindSafe for OpenFlags
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,