Struct ShareAccessFlags 

pub struct ShareAccessFlags { /* private fields */ }

Specifies the sharing mode for the open.

Reference: MS-SMB2 2.2.13

Implementations

impl ShareAccessFlags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl ShareAccessFlags

pub const fn into_bytes(self) -> [u8; 4]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 4]) -> Self

Converts the given bytes directly into the bitfield struct.

impl ShareAccessFlags

pub fn read(&self) -> <bool as Specifier>::InOut

Returns the value of read. Other opens are allowed to read this file while this open is present

pub fn read_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of read.

#Errors

If the returned value contains an invalid bit pattern for read. Other opens are allowed to read this file while this open is present

pub fn with_read(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of read set to the given value.

#Panics

If the given value is out of bounds for read. Other opens are allowed to read this file while this open is present

pub fn with_read_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of read set to the given value.

#Errors

If the given value is out of bounds for read. Other opens are allowed to read this file while this open is present

pub fn set_read(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of read to the given value.

#Panics

If the given value is out of bounds for read. Other opens are allowed to read this file while this open is present

pub fn set_read_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of read to the given value.

#Errors

If the given value is out of bounds for read. Other opens are allowed to read this file while this open is present

pub fn write(&self) -> <bool as Specifier>::InOut

Returns the value of write. Other opens are allowed to write this file while this open is present

pub fn write_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of write.

#Errors

If the returned value contains an invalid bit pattern for write. Other opens are allowed to write this file while this open is present

pub fn with_write(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of write set to the given value.

#Panics

If the given value is out of bounds for write. Other opens are allowed to write this file while this open is present

pub fn with_write_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of write set to the given value.

#Errors

If the given value is out of bounds for write. Other opens are allowed to write this file while this open is present

pub fn set_write(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of write to the given value.

#Panics

If the given value is out of bounds for write. Other opens are allowed to write this file while this open is present

pub fn set_write_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of write to the given value.

#Errors

If the given value is out of bounds for write. Other opens are allowed to write this file while this open is present

pub fn delete(&self) -> <bool as Specifier>::InOut

Returns the value of delete. Other opens are allowed to delete or rename this file while this open is present

pub fn delete_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of delete.

#Errors

If the returned value contains an invalid bit pattern for delete. Other opens are allowed to delete or rename this file while this open is present

pub fn with_delete(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of delete set to the given value.

#Panics

If the given value is out of bounds for delete. Other opens are allowed to delete or rename this file while this open is present

pub fn with_delete_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of delete set to the given value.

#Errors

If the given value is out of bounds for delete. Other opens are allowed to delete or rename this file while this open is present

pub fn set_delete(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of delete to the given value.

#Panics

If the given value is out of bounds for delete. Other opens are allowed to delete or rename this file while this open is present

pub fn set_delete_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of delete to the given value.

#Errors

If the given value is out of bounds for delete. Other opens are allowed to delete or rename this file while this open is present

Trait Implementations

impl BinRead for ShareAccessFlags

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl BinWrite for ShareAccessFlags

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_ne<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order.

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments.

impl CheckTotalSizeMultipleOf8 for ShareAccessFlags

type Size = TotalSize<[(); 0]>

impl Clone for ShareAccessFlags

fn clone(&self) -> ShareAccessFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShareAccessFlags

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

Formats the value using the given formatter.

impl Default for ShareAccessFlags

fn default() -> ShareAccessFlags

Returns the “default value” for a type.

impl PartialEq for ShareAccessFlags

fn eq(&self, other: &ShareAccessFlags) -> 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 ReadEndian for ShareAccessFlags

const ENDIAN: EndianKind = binrw::meta::EndianKind::None

The endianness of the type.

impl WriteEndian for ShareAccessFlags

const ENDIAN: EndianKind = binrw::meta::EndianKind::None

The endianness of the type.

impl Copy for ShareAccessFlags

impl Eq for ShareAccessFlags

impl StructuralPartialEq for ShareAccessFlags