Struct ssh2::RenameFlags

pub struct RenameFlags { /* fields omitted */ }

Options to Sftp::rename.

Implementations

impl RenameFlags

pub const OVERWRITE: RenameFlags

In a rename operation, overwrite the destination if it already exists. If this flag is not present then it is an error if the destination already exists.

pub const ATOMIC: RenameFlags

Inform the remote that an atomic rename operation is desired if available.

pub const NATIVE: RenameFlags

Inform the remote end that the native system calls for renaming should be used.

pub const fn empty() -> RenameFlags

Returns an empty set of flags

pub const fn all() -> RenameFlags

Returns the set containing all flags.

pub const fn bits(&self) -> c_long

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_long) -> Option<RenameFlags>

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_long) -> RenameFlags

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

pub const unsafe fn from_bits_unchecked(bits: c_long) -> RenameFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: RenameFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for RenameFlags

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

Formats the value using the given formatter.

impl BitAnd<RenameFlags> for RenameFlags

type Output = RenameFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<RenameFlags> for RenameFlags

fn bitand_assign(&mut self, other: RenameFlags)

Disables all flags disabled in the set.

impl BitOr<RenameFlags> for RenameFlags

type Output = RenameFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<RenameFlags> for RenameFlags

fn bitor_assign(&mut self, other: RenameFlags)

Adds the set of flags.

impl BitXor<RenameFlags> for RenameFlags

type Output = RenameFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<RenameFlags> for RenameFlags

fn bitxor_assign(&mut self, other: RenameFlags)

Toggles the set of flags.

impl Clone for RenameFlags

fn clone(&self) -> RenameFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RenameFlags

impl Debug for RenameFlags

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

Formats the value using the given formatter.

impl Eq for RenameFlags

impl Extend<RenameFlags> for RenameFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<RenameFlags> for RenameFlags

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

Creates a value from an iterator.

impl Hash for RenameFlags

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 LowerHex for RenameFlags

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

Formats the value using the given formatter.

impl Not for RenameFlags

type Output = RenameFlags

The resulting type after applying the ! operator.

fn not(self) -> RenameFlags

Returns the complement of this set of flags.

impl Octal for RenameFlags

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

Formats the value using the given formatter.

impl Ord for RenameFlags

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<RenameFlags> for RenameFlags

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

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

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

This method tests for !=.

impl PartialOrd<RenameFlags> for RenameFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for RenameFlags

impl StructuralPartialEq for RenameFlags

impl Sub<RenameFlags> for RenameFlags

type Output = RenameFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<RenameFlags> for RenameFlags

fn sub_assign(&mut self, other: RenameFlags)

Disables all flags enabled in the set.

impl UpperHex for RenameFlags

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

Formats the value using the given formatter.