Struct FileModeInformation 

pub struct FileModeInformation { /* private fields */ }

Query or Set file mode information.

MS-FSCC 2.4.31

Implementations

impl FileModeInformation

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl FileModeInformation

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 FileModeInformation

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

Returns the value of write_through. When set, system caching is not performed on the file.

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

Returns the value of write_through.

#Errors

If the returned value contains an invalid bit pattern for write_through. When set, system caching is not performed on the file.

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

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

#Panics

If the given value is out of bounds for write_through. When set, system caching is not performed on the file.

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

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

#Errors

If the given value is out of bounds for write_through. When set, system caching is not performed on the file.

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

Sets the value of write_through to the given value.

#Panics

If the given value is out of bounds for write_through. When set, system caching is not performed on the file.

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

Sets the value of write_through to the given value.

#Errors

If the given value is out of bounds for write_through. When set, system caching is not performed on the file.

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

Returns the value of sequential_access. When set, all access to the file is sequential.

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

Returns the value of sequential_access.

#Errors

If the returned value contains an invalid bit pattern for sequential_access. When set, all access to the file is sequential.

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

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

#Panics

If the given value is out of bounds for sequential_access. When set, all access to the file is sequential.

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

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

#Errors

If the given value is out of bounds for sequential_access. When set, all access to the file is sequential.

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

Sets the value of sequential_access to the given value.

#Panics

If the given value is out of bounds for sequential_access. When set, all access to the file is sequential.

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

Sets the value of sequential_access to the given value.

#Errors

If the given value is out of bounds for sequential_access. When set, all access to the file is sequential.

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

Returns the value of no_intermediate_buffering. When set, the file cannot be cached or buffered in a driver’s internal buffers.

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

Returns the value of no_intermediate_buffering.

#Errors

If the returned value contains an invalid bit pattern for no_intermediate_buffering. When set, the file cannot be cached or buffered in a driver’s internal buffers.

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

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

#Panics

If the given value is out of bounds for no_intermediate_buffering. When set, the file cannot be cached or buffered in a driver’s internal buffers.

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

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

#Errors

If the given value is out of bounds for no_intermediate_buffering. When set, the file cannot be cached or buffered in a driver’s internal buffers.

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

Sets the value of no_intermediate_buffering to the given value.

#Panics

If the given value is out of bounds for no_intermediate_buffering. When set, the file cannot be cached or buffered in a driver’s internal buffers.

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

Sets the value of no_intermediate_buffering to the given value.

#Errors

If the given value is out of bounds for no_intermediate_buffering. When set, the file cannot be cached or buffered in a driver’s internal buffers.

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

Returns the value of synchronous_io_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are alertable.

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

Returns the value of synchronous_io_alert.

#Errors

If the returned value contains an invalid bit pattern for synchronous_io_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are alertable.

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

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

#Panics

If the given value is out of bounds for synchronous_io_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are alertable.

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

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

#Errors

If the given value is out of bounds for synchronous_io_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are alertable.

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

Sets the value of synchronous_io_alert to the given value.

#Panics

If the given value is out of bounds for synchronous_io_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are alertable.

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

Sets the value of synchronous_io_alert to the given value.

#Errors

If the given value is out of bounds for synchronous_io_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are alertable.

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

Returns the value of synchronous_io_non_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are not alertable.

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

Returns the value of synchronous_io_non_alert.

#Errors

If the returned value contains an invalid bit pattern for synchronous_io_non_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are not alertable.

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

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

#Panics

If the given value is out of bounds for synchronous_io_non_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are not alertable.

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

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

#Errors

If the given value is out of bounds for synchronous_io_non_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are not alertable.

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

Sets the value of synchronous_io_non_alert to the given value.

#Panics

If the given value is out of bounds for synchronous_io_non_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are not alertable.

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

Sets the value of synchronous_io_non_alert to the given value.

#Errors

If the given value is out of bounds for synchronous_io_non_alert. When set, all operations on the file are performed synchronously. Waits in the system to synchronize I/O queuing and completion are not alertable.

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

Returns the value of delete_on_close. When set, the file will be deleted when the last handle to the file is closed.

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

Returns the value of delete_on_close.

#Errors

If the returned value contains an invalid bit pattern for delete_on_close. When set, the file will be deleted when the last handle to the file is closed.

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

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

#Panics

If the given value is out of bounds for delete_on_close. When set, the file will be deleted when the last handle to the file is closed.

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

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

#Errors

If the given value is out of bounds for delete_on_close. When set, the file will be deleted when the last handle to the file is closed.

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

Sets the value of delete_on_close to the given value.

#Panics

If the given value is out of bounds for delete_on_close. When set, the file will be deleted when the last handle to the file is closed.

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

Sets the value of delete_on_close to the given value.

#Errors

If the given value is out of bounds for delete_on_close. When set, the file will be deleted when the last handle to the file is closed.

Trait Implementations

impl BinRead for FileModeInformation

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 FileModeInformation

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 FileModeInformation

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

impl Clone for FileModeInformation

fn clone(&self) -> FileModeInformation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileModeInformation

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

Formats the value using the given formatter.

impl Default for FileModeInformation

fn default() -> FileModeInformation

Returns the “default value” for a type.

impl From<FileModeInformation> for QueryFileInfo

fn from(value: FileModeInformation) -> QueryFileInfo

Converts to this type from the input type.

impl From<FileModeInformation> for SetFileInfo

fn from(value: FileModeInformation) -> SetFileInfo

Converts to this type from the input type.

impl PartialEq for FileModeInformation

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

const CLASS_ID: QueryFileInfoClass = QueryFileInfoClass::ModeInformation

impl ReadEndian for FileModeInformation

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

The endianness of the type.

impl SetFileInfoValue for FileModeInformation

const CLASS_ID: SetFileInfoClass = SetFileInfoClass::ModeInformation

impl TryFrom<QueryFileInfo> for FileModeInformation

type Error = SmbFsccError

The type returned in the event of a conversion error.

fn try_from(value: QueryFileInfo) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SetFileInfo> for FileModeInformation

type Error = SmbFsccError

The type returned in the event of a conversion error.

fn try_from(value: SetFileInfo) -> Result<Self, Self::Error>

Performs the conversion.

impl WriteEndian for FileModeInformation

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

The endianness of the type.

impl Copy for FileModeInformation

impl Eq for FileModeInformation

impl StructuralPartialEq for FileModeInformation