Struct HeaderFlags 

pub struct HeaderFlags { /* private fields */ }

SMB2 header flags.

Indicates how to process the operation.

Reference: MS-SMB2 2.2.1.2

Implementations

impl HeaderFlags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl HeaderFlags

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 HeaderFlags

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

Returns the value of server_to_redir. Message is a server response (set in responses).

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

Returns the value of server_to_redir.

#Errors

If the returned value contains an invalid bit pattern for server_to_redir. Message is a server response (set in responses).

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

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

#Panics

If the given value is out of bounds for server_to_redir. Message is a server response (set in responses).

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

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

#Errors

If the given value is out of bounds for server_to_redir. Message is a server response (set in responses).

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

Sets the value of server_to_redir to the given value.

#Panics

If the given value is out of bounds for server_to_redir. Message is a server response (set in responses).

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

Sets the value of server_to_redir to the given value.

#Errors

If the given value is out of bounds for server_to_redir. Message is a server response (set in responses).

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

Returns the value of async_command. Message is part of an asynchronous operation.

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

Returns the value of async_command.

#Errors

If the returned value contains an invalid bit pattern for async_command. Message is part of an asynchronous operation.

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

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

#Panics

If the given value is out of bounds for async_command. Message is part of an asynchronous operation.

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

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

#Errors

If the given value is out of bounds for async_command. Message is part of an asynchronous operation.

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

Sets the value of async_command to the given value.

#Panics

If the given value is out of bounds for async_command. Message is part of an asynchronous operation.

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

Sets the value of async_command to the given value.

#Errors

If the given value is out of bounds for async_command. Message is part of an asynchronous operation.

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

Returns the value of related_operations. Request is a related operation in a compounded chain.

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

Returns the value of related_operations.

#Errors

If the returned value contains an invalid bit pattern for related_operations. Request is a related operation in a compounded chain.

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

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

#Panics

If the given value is out of bounds for related_operations. Request is a related operation in a compounded chain.

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

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

#Errors

If the given value is out of bounds for related_operations. Request is a related operation in a compounded chain.

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

Sets the value of related_operations to the given value.

#Panics

If the given value is out of bounds for related_operations. Request is a related operation in a compounded chain.

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

Sets the value of related_operations to the given value.

#Errors

If the given value is out of bounds for related_operations. Request is a related operation in a compounded chain.

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

Returns the value of signed. Message is signed.

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

Returns the value of signed.

#Errors

If the returned value contains an invalid bit pattern for signed. Message is signed.

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

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

#Panics

If the given value is out of bounds for signed. Message is signed.

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

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

#Errors

If the given value is out of bounds for signed. Message is signed.

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

Sets the value of signed to the given value.

#Panics

If the given value is out of bounds for signed. Message is signed.

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

Sets the value of signed to the given value.

#Errors

If the given value is out of bounds for signed. Message is signed.

pub fn priority_mask(&self) -> <B3 as Specifier>::InOut

Returns the value of priority_mask. Priority mask for quality of service.

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

Returns the value of priority_mask.

#Errors

If the returned value contains an invalid bit pattern for priority_mask. Priority mask for quality of service.

pub fn with_priority_mask(self, new_val: <B3 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for priority_mask. Priority mask for quality of service.

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

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

#Errors

If the given value is out of bounds for priority_mask. Priority mask for quality of service.

pub fn set_priority_mask(&mut self, new_val: <B3 as Specifier>::InOut)

Sets the value of priority_mask to the given value.

#Panics

If the given value is out of bounds for priority_mask. Priority mask for quality of service.

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

Sets the value of priority_mask to the given value.

#Errors

If the given value is out of bounds for priority_mask. Priority mask for quality of service.

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

Returns the value of dfs_operation. Request is a DFS operation.

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

Returns the value of dfs_operation.

#Errors

If the returned value contains an invalid bit pattern for dfs_operation. Request is a DFS operation.

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

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

#Panics

If the given value is out of bounds for dfs_operation. Request is a DFS operation.

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

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

#Errors

If the given value is out of bounds for dfs_operation. Request is a DFS operation.

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

Sets the value of dfs_operation to the given value.

#Panics

If the given value is out of bounds for dfs_operation. Request is a DFS operation.

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

Sets the value of dfs_operation to the given value.

#Errors

If the given value is out of bounds for dfs_operation. Request is a DFS operation.

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

Returns the value of replay_operation. Request is a replay operation for resilient handles.

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

Returns the value of replay_operation.

#Errors

If the returned value contains an invalid bit pattern for replay_operation. Request is a replay operation for resilient handles.

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

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

#Panics

If the given value is out of bounds for replay_operation. Request is a replay operation for resilient handles.

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

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

#Errors

If the given value is out of bounds for replay_operation. Request is a replay operation for resilient handles.

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

Sets the value of replay_operation to the given value.

#Panics

If the given value is out of bounds for replay_operation. Request is a replay operation for resilient handles.

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

Sets the value of replay_operation to the given value.

#Errors

If the given value is out of bounds for replay_operation. Request is a replay operation for resilient handles.

Trait Implementations

impl BinRead for HeaderFlags

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 HeaderFlags

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 HeaderFlags

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

impl Clone for HeaderFlags

fn clone(&self) -> HeaderFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderFlags

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

Formats the value using the given formatter.

impl Default for HeaderFlags

fn default() -> HeaderFlags

Returns the “default value” for a type.

impl PartialEq for HeaderFlags

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

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

The endianness of the type.

impl WriteEndian for HeaderFlags

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

The endianness of the type.

impl Copy for HeaderFlags

impl Eq for HeaderFlags

impl StructuralPartialEq for HeaderFlags