Struct LockFlag 

pub struct LockFlag { /* private fields */ }

Lock flags describing how the range is being locked or unlocked. Valid combinations are: shared lock, exclusive lock, unlock, or any of shared/exclusive combined with fail_immediately.

Reference: MS-SMB2 2.2.26.1

Implementations

impl LockFlag

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl LockFlag

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 LockFlag

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

Returns the value of shared. Range must be locked shared, allowing other opens to read or take shared locks. Other opens must not be allowed to write within the range.

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

Returns the value of shared.

#Errors

If the returned value contains an invalid bit pattern for shared. Range must be locked shared, allowing other opens to read or take shared locks. Other opens must not be allowed to write within the range.

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

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

#Panics

If the given value is out of bounds for shared. Range must be locked shared, allowing other opens to read or take shared locks. Other opens must not be allowed to write within the range.

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

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

#Errors

If the given value is out of bounds for shared. Range must be locked shared, allowing other opens to read or take shared locks. Other opens must not be allowed to write within the range.

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

Sets the value of shared to the given value.

#Panics

If the given value is out of bounds for shared. Range must be locked shared, allowing other opens to read or take shared locks. Other opens must not be allowed to write within the range.

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

Sets the value of shared to the given value.

#Errors

If the given value is out of bounds for shared. Range must be locked shared, allowing other opens to read or take shared locks. Other opens must not be allowed to write within the range.

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

Returns the value of exclusive. Range must be locked exclusive, not allowing other opens to read, write, or lock within the range.

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

Returns the value of exclusive.

#Errors

If the returned value contains an invalid bit pattern for exclusive. Range must be locked exclusive, not allowing other opens to read, write, or lock within the range.

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

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

#Panics

If the given value is out of bounds for exclusive. Range must be locked exclusive, not allowing other opens to read, write, or lock within the range.

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

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

#Errors

If the given value is out of bounds for exclusive. Range must be locked exclusive, not allowing other opens to read, write, or lock within the range.

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

Sets the value of exclusive to the given value.

#Panics

If the given value is out of bounds for exclusive. Range must be locked exclusive, not allowing other opens to read, write, or lock within the range.

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

Sets the value of exclusive to the given value.

#Errors

If the given value is out of bounds for exclusive. Range must be locked exclusive, not allowing other opens to read, write, or lock within the range.

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

Returns the value of unlock. Range must be unlocked from a previous lock. Unlock range must be identical to lock range.

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

Returns the value of unlock.

#Errors

If the returned value contains an invalid bit pattern for unlock. Range must be unlocked from a previous lock. Unlock range must be identical to lock range.

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

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

#Panics

If the given value is out of bounds for unlock. Range must be unlocked from a previous lock. Unlock range must be identical to lock range.

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

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

#Errors

If the given value is out of bounds for unlock. Range must be unlocked from a previous lock. Unlock range must be identical to lock range.

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

Sets the value of unlock to the given value.

#Panics

If the given value is out of bounds for unlock. Range must be unlocked from a previous lock. Unlock range must be identical to lock range.

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

Sets the value of unlock to the given value.

#Errors

If the given value is out of bounds for unlock. Range must be unlocked from a previous lock. Unlock range must be identical to lock range.

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

Returns the value of fail_immediately. Lock operation must fail immediately if it conflicts with an existing lock, instead of waiting for the range to become available.

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

Returns the value of fail_immediately.

#Errors

If the returned value contains an invalid bit pattern for fail_immediately. Lock operation must fail immediately if it conflicts with an existing lock, instead of waiting for the range to become available.

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

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

#Panics

If the given value is out of bounds for fail_immediately. Lock operation must fail immediately if it conflicts with an existing lock, instead of waiting for the range to become available.

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

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

#Errors

If the given value is out of bounds for fail_immediately. Lock operation must fail immediately if it conflicts with an existing lock, instead of waiting for the range to become available.

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

Sets the value of fail_immediately to the given value.

#Panics

If the given value is out of bounds for fail_immediately. Lock operation must fail immediately if it conflicts with an existing lock, instead of waiting for the range to become available.

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

Sets the value of fail_immediately to the given value.

#Errors

If the given value is out of bounds for fail_immediately. Lock operation must fail immediately if it conflicts with an existing lock, instead of waiting for the range to become available.

Trait Implementations

impl BinRead for LockFlag

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 LockFlag

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 LockFlag

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

impl Clone for LockFlag

fn clone(&self) -> LockFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockFlag

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

Formats the value using the given formatter.

impl Default for LockFlag

fn default() -> LockFlag

Returns the “default value” for a type.

impl PartialEq for LockFlag

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

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

The endianness of the type.

impl WriteEndian for LockFlag

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

The endianness of the type.

impl Copy for LockFlag

impl Eq for LockFlag

impl StructuralPartialEq for LockFlag