Struct ssh2::OpenFlags

pub struct OpenFlags { /* fields omitted */ }

Options that can be used to configure how a file is opened

Methods

impl OpenFlags

pub const READ: OpenFlags

Open the file for reading.

pub const WRITE: OpenFlags

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

Force all writes to append data at the end of the file.

pub const CREATE: OpenFlags

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

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

Causes the request to fail if the named file already exists. Using this flag implies the Create flag.

pub const fn empty() -> OpenFlags

Returns an empty set of flags

pub const fn all() -> OpenFlags

Returns the set containing all flags.

pub const fn bits(&self) -> c_ulong

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_ulong) -> Option<OpenFlags>

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: OpenFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: OpenFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: OpenFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: OpenFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: OpenFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: OpenFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Extend<OpenFlags> for OpenFlags

fn extend<T: IntoIterator<Item = OpenFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl Clone for OpenFlags

fn clone(&self) -> OpenFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Ord for OpenFlags

fn cmp(&self, other: &OpenFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<OpenFlags> for OpenFlags

fn partial_cmp(&self, other: &OpenFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &OpenFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &OpenFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &OpenFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &OpenFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<OpenFlags> for OpenFlags

fn eq(&self, other: &OpenFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OpenFlags) -> bool

This method tests for !=.

impl Copy for OpenFlags

impl Eq for OpenFlags

impl Debug for OpenFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Sub<OpenFlags> for OpenFlags

type Output = OpenFlags

The resulting type after applying the - operator.

fn sub(self, other: OpenFlags) -> OpenFlags

Returns the set difference of the two sets of flags.

impl SubAssign<OpenFlags> for OpenFlags

fn sub_assign(&mut self, other: OpenFlags)

Disables all flags enabled in the set.

impl Not for OpenFlags

type Output = OpenFlags

The resulting type after applying the ! operator.

fn not(self) -> OpenFlags

Returns the complement of this set of flags.

impl BitAnd<OpenFlags> for OpenFlags

type Output = OpenFlags

The resulting type after applying the & operator.

fn bitand(self, other: OpenFlags) -> OpenFlags

Returns the intersection between the two sets of flags.

impl BitOr<OpenFlags> for OpenFlags

type Output = OpenFlags

The resulting type after applying the | operator.

fn bitor(self, other: OpenFlags) -> OpenFlags

Returns the union of the two sets of flags.

impl BitXor<OpenFlags> for OpenFlags

type Output = OpenFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: OpenFlags) -> OpenFlags

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<OpenFlags> for OpenFlags

fn bitand_assign(&mut self, other: OpenFlags)

Disables all flags disabled in the set.

impl BitOrAssign<OpenFlags> for OpenFlags

fn bitor_assign(&mut self, other: OpenFlags)

Adds the set of flags.

impl BitXorAssign<OpenFlags> for OpenFlags

fn bitxor_assign(&mut self, other: OpenFlags)

Toggles the set of flags.

impl Hash for OpenFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl FromIterator<OpenFlags> for OpenFlags

fn from_iter<T: IntoIterator<Item = OpenFlags>>(iterator: T) -> OpenFlags

Creates a value from an iterator.

impl Octal for OpenFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Binary for OpenFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl LowerHex for OpenFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl UpperHex for OpenFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.