Struct QueryDirectoryFlags 

pub struct QueryDirectoryFlags { /* private fields */ }

Flags indicating how the query directory operation must be processed.

These flags control the behavior of directory enumeration, such as whether to restart the scan from the beginning or return only a single entry.

Reference: MS-SMB2 section 2.2.33

Implementations

impl QueryDirectoryFlags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl QueryDirectoryFlags

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

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; 1]) -> Self

Converts the given bytes directly into the bitfield struct.

impl QueryDirectoryFlags

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

Returns the value of restart_scans. The server is requested to restart the enumeration from the beginning.

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

Returns the value of restart_scans.

#Errors

If the returned value contains an invalid bit pattern for restart_scans. The server is requested to restart the enumeration from the beginning.

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

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

#Panics

If the given value is out of bounds for restart_scans. The server is requested to restart the enumeration from the beginning.

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

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

#Errors

If the given value is out of bounds for restart_scans. The server is requested to restart the enumeration from the beginning.

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

Sets the value of restart_scans to the given value.

#Panics

If the given value is out of bounds for restart_scans. The server is requested to restart the enumeration from the beginning.

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

Sets the value of restart_scans to the given value.

#Errors

If the given value is out of bounds for restart_scans. The server is requested to restart the enumeration from the beginning.

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

Returns the value of return_single_entry. The server is requested to only return the first entry of the search results.

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

Returns the value of return_single_entry.

#Errors

If the returned value contains an invalid bit pattern for return_single_entry. The server is requested to only return the first entry of the search results.

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

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

#Panics

If the given value is out of bounds for return_single_entry. The server is requested to only return the first entry of the search results.

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

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

#Errors

If the given value is out of bounds for return_single_entry. The server is requested to only return the first entry of the search results.

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

Sets the value of return_single_entry to the given value.

#Panics

If the given value is out of bounds for return_single_entry. The server is requested to only return the first entry of the search results.

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

Sets the value of return_single_entry to the given value.

#Errors

If the given value is out of bounds for return_single_entry. The server is requested to only return the first entry of the search results.

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

Returns the value of index_specified. The server is requested to return entries beginning at the byte number specified by FileIndex.

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

Returns the value of index_specified.

#Errors

If the returned value contains an invalid bit pattern for index_specified. The server is requested to return entries beginning at the byte number specified by FileIndex.

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

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

#Panics

If the given value is out of bounds for index_specified. The server is requested to return entries beginning at the byte number specified by FileIndex.

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

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

#Errors

If the given value is out of bounds for index_specified. The server is requested to return entries beginning at the byte number specified by FileIndex.

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

Sets the value of index_specified to the given value.

#Panics

If the given value is out of bounds for index_specified. The server is requested to return entries beginning at the byte number specified by FileIndex.

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

Sets the value of index_specified to the given value.

#Errors

If the given value is out of bounds for index_specified. The server is requested to return entries beginning at the byte number specified by FileIndex.

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

Returns the value of reopen. The server is requested to restart the enumeration from the beginning, and the search pattern is to be changed.

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

Returns the value of reopen.

#Errors

If the returned value contains an invalid bit pattern for reopen. The server is requested to restart the enumeration from the beginning, and the search pattern is to be changed.

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

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

#Panics

If the given value is out of bounds for reopen. The server is requested to restart the enumeration from the beginning, and the search pattern is to be changed.

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

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

#Errors

If the given value is out of bounds for reopen. The server is requested to restart the enumeration from the beginning, and the search pattern is to be changed.

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

Sets the value of reopen to the given value.

#Panics

If the given value is out of bounds for reopen. The server is requested to restart the enumeration from the beginning, and the search pattern is to be changed.

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

Sets the value of reopen to the given value.

#Errors

If the given value is out of bounds for reopen. The server is requested to restart the enumeration from the beginning, and the search pattern is to be changed.

Trait Implementations

impl BinRead for QueryDirectoryFlags

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 QueryDirectoryFlags

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 QueryDirectoryFlags

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

impl Clone for QueryDirectoryFlags

fn clone(&self) -> QueryDirectoryFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryDirectoryFlags

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

Formats the value using the given formatter.

impl Default for QueryDirectoryFlags

fn default() -> QueryDirectoryFlags

Returns the “default value” for a type.

impl PartialEq for QueryDirectoryFlags

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

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

The endianness of the type.

impl WriteEndian for QueryDirectoryFlags

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

The endianness of the type.

impl Copy for QueryDirectoryFlags

impl Eq for QueryDirectoryFlags

impl StructuralPartialEq for QueryDirectoryFlags