Struct GlobalCapabilities 

pub struct GlobalCapabilities { /* private fields */ }

Global capabilities flags for SMB2/SMB3.

Indicates various protocol capabilities supported by the client or server.

Reference: MS-SMB2 2.2.3

Implementations

impl GlobalCapabilities

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl GlobalCapabilities

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 GlobalCapabilities

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

Returns the value of dfs. DFS support.

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

Returns the value of dfs.

#Errors

If the returned value contains an invalid bit pattern for dfs. DFS support.

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

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

#Panics

If the given value is out of bounds for dfs. DFS support.

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

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

#Errors

If the given value is out of bounds for dfs. DFS support.

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

Sets the value of dfs to the given value.

#Panics

If the given value is out of bounds for dfs. DFS support.

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

Sets the value of dfs to the given value.

#Errors

If the given value is out of bounds for dfs. DFS support.

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

Returns the value of leasing. File leasing support.

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

Returns the value of leasing.

#Errors

If the returned value contains an invalid bit pattern for leasing. File leasing support.

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

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

#Panics

If the given value is out of bounds for leasing. File leasing support.

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

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

#Errors

If the given value is out of bounds for leasing. File leasing support.

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

Sets the value of leasing to the given value.

#Panics

If the given value is out of bounds for leasing. File leasing support.

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

Sets the value of leasing to the given value.

#Errors

If the given value is out of bounds for leasing. File leasing support.

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

Returns the value of large_mtu. Large MTU support (multiple credit operations).

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

Returns the value of large_mtu.

#Errors

If the returned value contains an invalid bit pattern for large_mtu. Large MTU support (multiple credit operations).

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

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

#Panics

If the given value is out of bounds for large_mtu. Large MTU support (multiple credit operations).

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

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

#Errors

If the given value is out of bounds for large_mtu. Large MTU support (multiple credit operations).

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

Sets the value of large_mtu to the given value.

#Panics

If the given value is out of bounds for large_mtu. Large MTU support (multiple credit operations).

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

Sets the value of large_mtu to the given value.

#Errors

If the given value is out of bounds for large_mtu. Large MTU support (multiple credit operations).

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

Returns the value of multi_channel. Multi-channel support.

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

Returns the value of multi_channel.

#Errors

If the returned value contains an invalid bit pattern for multi_channel. Multi-channel support.

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

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

#Panics

If the given value is out of bounds for multi_channel. Multi-channel support.

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

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

#Errors

If the given value is out of bounds for multi_channel. Multi-channel support.

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

Sets the value of multi_channel to the given value.

#Panics

If the given value is out of bounds for multi_channel. Multi-channel support.

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

Sets the value of multi_channel to the given value.

#Errors

If the given value is out of bounds for multi_channel. Multi-channel support.

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

Returns the value of persistent_handles. Persistent handles support.

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

Returns the value of persistent_handles.

#Errors

If the returned value contains an invalid bit pattern for persistent_handles. Persistent handles support.

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

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

#Panics

If the given value is out of bounds for persistent_handles. Persistent handles support.

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

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

#Errors

If the given value is out of bounds for persistent_handles. Persistent handles support.

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

Sets the value of persistent_handles to the given value.

#Panics

If the given value is out of bounds for persistent_handles. Persistent handles support.

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

Sets the value of persistent_handles to the given value.

#Errors

If the given value is out of bounds for persistent_handles. Persistent handles support.

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

Returns the value of directory_leasing. Directory leasing support.

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

Returns the value of directory_leasing.

#Errors

If the returned value contains an invalid bit pattern for directory_leasing. Directory leasing support.

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

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

#Panics

If the given value is out of bounds for directory_leasing. Directory leasing support.

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

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

#Errors

If the given value is out of bounds for directory_leasing. Directory leasing support.

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

Sets the value of directory_leasing to the given value.

#Panics

If the given value is out of bounds for directory_leasing. Directory leasing support.

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

Sets the value of directory_leasing to the given value.

#Errors

If the given value is out of bounds for directory_leasing. Directory leasing support.

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

Returns the value of encryption. Encryption support.

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

Returns the value of encryption.

#Errors

If the returned value contains an invalid bit pattern for encryption. Encryption support.

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

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

#Panics

If the given value is out of bounds for encryption. Encryption support.

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

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

#Errors

If the given value is out of bounds for encryption. Encryption support.

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

Sets the value of encryption to the given value.

#Panics

If the given value is out of bounds for encryption. Encryption support.

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

Sets the value of encryption to the given value.

#Errors

If the given value is out of bounds for encryption. Encryption support.

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

Returns the value of notifications. Change notifications support.

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

Returns the value of notifications.

#Errors

If the returned value contains an invalid bit pattern for notifications. Change notifications support.

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

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

#Panics

If the given value is out of bounds for notifications. Change notifications support.

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

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

#Errors

If the given value is out of bounds for notifications. Change notifications support.

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

Sets the value of notifications to the given value.

#Panics

If the given value is out of bounds for notifications. Change notifications support.

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

Sets the value of notifications to the given value.

#Errors

If the given value is out of bounds for notifications. Change notifications support.

Trait Implementations

impl BinRead for GlobalCapabilities

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 GlobalCapabilities

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 GlobalCapabilities

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

impl Clone for GlobalCapabilities

fn clone(&self) -> GlobalCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalCapabilities

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

Formats the value using the given formatter.

impl Default for GlobalCapabilities

fn default() -> GlobalCapabilities

Returns the “default value” for a type.

impl PartialEq for GlobalCapabilities

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

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

The endianness of the type.

impl WriteEndian for GlobalCapabilities

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

The endianness of the type.

impl Copy for GlobalCapabilities

impl Eq for GlobalCapabilities

impl StructuralPartialEq for GlobalCapabilities