Struct DISPOSITION

pub struct DISPOSITION(/* private fields */);

Available on crate feature kernel only.

HFILE::CreateFile creation_disposition (u32).

Originally has no prefix.

Implementations

impl DISPOSITION

pub const unsafe fn as_mut(&mut self) -> &mut u32

Returns a mutable reference to the underlying raw value.

Safety

Be sure the integer being set is meaningful for the actual type.

pub const unsafe fn from_raw(v: u32) -> Self

Constructs a new object by wrapping the given integer value.

Safety

Be sure the given value is meaningful for the actual type.

pub const fn raw(&self) -> u32

Returns the primitive integer underlying value.

This method is similar to Into, but it is const, therefore it can be used in const contexts.

impl DISPOSITION

pub const CREATE_NEW: Self

Creates a new file only if it does not already exist.

If the specified file exists the function fails and the last-error code is set to ERROR::FILE_EXISTS.

If the specified file does not exist and is a valid path to a writable location a new file is created.

pub const CREATE_ALWAYS: Self

Creates a new file always.

If the specified file exists and is writable the function overwrites the file the function succeeds and last-error code is set to ERROR::ALREADY_EXISTS.

If the specified file does not exist and is a valid path a new file is created the function succeeds and the last-error code is set to ERROR::SUCCESS.

pub const OPEN_EXISTING: Self

Opens a file or device only if it exists.

If the specified file or device does not exist the function fails and the last-error code is set to ERROR::FILE_NOT_FOUND.

pub const OPEN_ALWAYS: Self

Opens a file always.

If the specified file exists the function succeeds and the last-error code is set to ERROR::ALREADY_EXISTS.

If the specified file does not exist and is a valid path to a writable location the function creates a file and the last-error code is set to ERROR::SUCCESS.

pub const TRUNCATE_EXISTING: Self

Opens a file and truncates it so that its size is zero bytes only if it exists.

If the specified file does not exist the function fails and the last-error code is set to ERROR::FILE_NOT_FOUND.

The calling process must open the file with the GENERIC::WRITE bit set as part of the dwDesiredAccess parameter.

Trait Implementations

impl AsRef<u32> for DISPOSITION

fn as_ref(&self) -> &u32

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for DISPOSITION

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

Formats the value using the given formatter.

impl Clone for DISPOSITION

fn clone(&self) -> DISPOSITION

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DISPOSITION

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

Formats the value using the given formatter.

impl Default for DISPOSITION

fn default() -> DISPOSITION

Returns the “default value” for a type.

impl Display for DISPOSITION

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

Formats the value using the given formatter.

impl From<DISPOSITION> for u32

fn from(v: DISPOSITION) -> Self

Converts to this type from the input type.

impl Hash for DISPOSITION

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for DISPOSITION

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

Formats the value using the given formatter.

impl Octal for DISPOSITION

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

Formats the value using the given formatter.

impl Ord for DISPOSITION

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DISPOSITION

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DISPOSITION

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl UpperHex for DISPOSITION

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

Formats the value using the given formatter.

impl Copy for DISPOSITION

impl Eq for DISPOSITION

impl StructuralPartialEq for DISPOSITION