Struct TreeCapabilities 

pub struct TreeCapabilities { /* private fields */ }

Tree capabilities indicating various share capabilities

Reference: MS-SMB2 2.2.10

Implementations

impl TreeCapabilities

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl TreeCapabilities

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 TreeCapabilities

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

Returns the value of dfs. Share is present in a DFS tree structure

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. Share is present in a DFS tree structure

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. Share is present in a DFS tree structure

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. Share is present in a DFS tree structure

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. Share is present in a DFS tree structure

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. Share is present in a DFS tree structure

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

Returns the value of continuous_availability. Share is continuously available

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

Returns the value of continuous_availability.

#Errors

If the returned value contains an invalid bit pattern for continuous_availability. Share is continuously available

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

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

#Panics

If the given value is out of bounds for continuous_availability. Share is continuously available

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

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

#Errors

If the given value is out of bounds for continuous_availability. Share is continuously available

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

Sets the value of continuous_availability to the given value.

#Panics

If the given value is out of bounds for continuous_availability. Share is continuously available

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

Sets the value of continuous_availability to the given value.

#Errors

If the given value is out of bounds for continuous_availability. Share is continuously available

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

Returns the value of scaleout. Share facilitates faster recovery of durable handles

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

Returns the value of scaleout.

#Errors

If the returned value contains an invalid bit pattern for scaleout. Share facilitates faster recovery of durable handles

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

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

#Panics

If the given value is out of bounds for scaleout. Share facilitates faster recovery of durable handles

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

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

#Errors

If the given value is out of bounds for scaleout. Share facilitates faster recovery of durable handles

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

Sets the value of scaleout to the given value.

#Panics

If the given value is out of bounds for scaleout. Share facilitates faster recovery of durable handles

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

Sets the value of scaleout to the given value.

#Errors

If the given value is out of bounds for scaleout. Share facilitates faster recovery of durable handles

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

Returns the value of cluster. Share provides monitoring through the Witness service

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

Returns the value of cluster.

#Errors

If the returned value contains an invalid bit pattern for cluster. Share provides monitoring through the Witness service

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

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

#Panics

If the given value is out of bounds for cluster. Share provides monitoring through the Witness service

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

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

#Errors

If the given value is out of bounds for cluster. Share provides monitoring through the Witness service

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

Sets the value of cluster to the given value.

#Panics

If the given value is out of bounds for cluster. Share provides monitoring through the Witness service

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

Sets the value of cluster to the given value.

#Errors

If the given value is out of bounds for cluster. Share provides monitoring through the Witness service

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

Returns the value of asymmetric. Share allows dynamic changes in ownership

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

Returns the value of asymmetric.

#Errors

If the returned value contains an invalid bit pattern for asymmetric. Share allows dynamic changes in ownership

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

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

#Panics

If the given value is out of bounds for asymmetric. Share allows dynamic changes in ownership

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

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

#Errors

If the given value is out of bounds for asymmetric. Share allows dynamic changes in ownership

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

Sets the value of asymmetric to the given value.

#Panics

If the given value is out of bounds for asymmetric. Share allows dynamic changes in ownership

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

Sets the value of asymmetric to the given value.

#Errors

If the given value is out of bounds for asymmetric. Share allows dynamic changes in ownership

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

Returns the value of redirect_to_owner. Share supports synchronous share level redirection

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

Returns the value of redirect_to_owner.

#Errors

If the returned value contains an invalid bit pattern for redirect_to_owner. Share supports synchronous share level redirection

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

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

#Panics

If the given value is out of bounds for redirect_to_owner. Share supports synchronous share level redirection

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

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

#Errors

If the given value is out of bounds for redirect_to_owner. Share supports synchronous share level redirection

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

Sets the value of redirect_to_owner to the given value.

#Panics

If the given value is out of bounds for redirect_to_owner. Share supports synchronous share level redirection

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

Sets the value of redirect_to_owner to the given value.

#Errors

If the given value is out of bounds for redirect_to_owner. Share supports synchronous share level redirection

Trait Implementations

impl BinRead for TreeCapabilities

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 TreeCapabilities

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 TreeCapabilities

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

impl Clone for TreeCapabilities

fn clone(&self) -> TreeCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeCapabilities

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

Formats the value using the given formatter.

impl Default for TreeCapabilities

fn default() -> TreeCapabilities

Returns the “default value” for a type.

impl PartialEq for TreeCapabilities

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

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

The endianness of the type.

impl WriteEndian for TreeCapabilities

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

The endianness of the type.

impl Copy for TreeCapabilities

impl Eq for TreeCapabilities

impl StructuralPartialEq for TreeCapabilities