Struct AccessMask 

pub struct AccessMask { /* private fields */ }

This struct was partially generated by the smb_dtyp::access_mask! macro. Read more about generic access rights and standard access rights

Implementations

impl AccessMask

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl AccessMask

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 AccessMask

pub fn common(&self) -> <B16 as Specifier>::InOut

Returns the value of common.

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

Returns the value of common.

#Errors

If the returned value contains an invalid bit pattern for common.

pub fn with_common(self, new_val: <B16 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for common.

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

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

#Errors

If the given value is out of bounds for common.

pub fn set_common(&mut self, new_val: <B16 as Specifier>::InOut)

Sets the value of common to the given value.

#Panics

If the given value is out of bounds for common.

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

Sets the value of common to the given value.

#Errors

If the given value is out of bounds for common.

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

Returns the value of delete. (std) The right to delete the object.

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

Returns the value of delete.

#Errors

If the returned value contains an invalid bit pattern for delete. (std) The right to delete the object.

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

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

#Panics

If the given value is out of bounds for delete. (std) The right to delete the object.

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

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

#Errors

If the given value is out of bounds for delete. (std) The right to delete the object.

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

Sets the value of delete to the given value.

#Panics

If the given value is out of bounds for delete. (std) The right to delete the object.

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

Sets the value of delete to the given value.

#Errors

If the given value is out of bounds for delete. (std) The right to delete the object.

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

Returns the value of read_control. (std) The right to read the information in the object’s security descriptor, not including the information in the system access control list (SACL).

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

Returns the value of read_control.

#Errors

If the returned value contains an invalid bit pattern for read_control. (std) The right to read the information in the object’s security descriptor, not including the information in the system access control list (SACL).

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

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

#Panics

If the given value is out of bounds for read_control. (std) The right to read the information in the object’s security descriptor, not including the information in the system access control list (SACL).

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

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

#Errors

If the given value is out of bounds for read_control. (std) The right to read the information in the object’s security descriptor, not including the information in the system access control list (SACL).

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

Sets the value of read_control to the given value.

#Panics

If the given value is out of bounds for read_control. (std) The right to read the information in the object’s security descriptor, not including the information in the system access control list (SACL).

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

Sets the value of read_control to the given value.

#Errors

If the given value is out of bounds for read_control. (std) The right to read the information in the object’s security descriptor, not including the information in the system access control list (SACL).

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

Returns the value of write_dacl. (std) The right to modify the discretionary access control list (DACL) in the object’s security descriptor.

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

Returns the value of write_dacl.

#Errors

If the returned value contains an invalid bit pattern for write_dacl. (std) The right to modify the discretionary access control list (DACL) in the object’s security descriptor.

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

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

#Panics

If the given value is out of bounds for write_dacl. (std) The right to modify the discretionary access control list (DACL) in the object’s security descriptor.

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

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

#Errors

If the given value is out of bounds for write_dacl. (std) The right to modify the discretionary access control list (DACL) in the object’s security descriptor.

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

Sets the value of write_dacl to the given value.

#Panics

If the given value is out of bounds for write_dacl. (std) The right to modify the discretionary access control list (DACL) in the object’s security descriptor.

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

Sets the value of write_dacl to the given value.

#Errors

If the given value is out of bounds for write_dacl. (std) The right to modify the discretionary access control list (DACL) in the object’s security descriptor.

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

Returns the value of write_owner. (std) The right to change the owner in the security descriptor for the object.

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

Returns the value of write_owner.

#Errors

If the returned value contains an invalid bit pattern for write_owner. (std) The right to change the owner in the security descriptor for the object.

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

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

#Panics

If the given value is out of bounds for write_owner. (std) The right to change the owner in the security descriptor for the object.

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

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

#Errors

If the given value is out of bounds for write_owner. (std) The right to change the owner in the security descriptor for the object.

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

Sets the value of write_owner to the given value.

#Panics

If the given value is out of bounds for write_owner. (std) The right to change the owner in the security descriptor for the object.

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

Sets the value of write_owner to the given value.

#Errors

If the given value is out of bounds for write_owner. (std) The right to change the owner in the security descriptor for the object.

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

Returns the value of synchronize. (std) The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

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

Returns the value of synchronize.

#Errors

If the returned value contains an invalid bit pattern for synchronize. (std) The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

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

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

#Panics

If the given value is out of bounds for synchronize. (std) The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

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

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

#Errors

If the given value is out of bounds for synchronize. (std) The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

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

Sets the value of synchronize to the given value.

#Panics

If the given value is out of bounds for synchronize. (std) The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

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

Sets the value of synchronize to the given value.

#Errors

If the given value is out of bounds for synchronize. (std) The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

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

Returns the value of access_system_security. The ability to get or set the SACL in an object’s security descriptor.

Read more on MSDN - SACL Access Right

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

Returns the value of access_system_security.

#Errors

If the returned value contains an invalid bit pattern for access_system_security. The ability to get or set the SACL in an object’s security descriptor.

Read more on MSDN - SACL Access Right

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

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

#Panics

If the given value is out of bounds for access_system_security. The ability to get or set the SACL in an object’s security descriptor.

Read more on MSDN - SACL Access Right

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

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

#Errors

If the given value is out of bounds for access_system_security. The ability to get or set the SACL in an object’s security descriptor.

Read more on MSDN - SACL Access Right

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

Sets the value of access_system_security to the given value.

#Panics

If the given value is out of bounds for access_system_security. The ability to get or set the SACL in an object’s security descriptor.

Read more on MSDN - SACL Access Right

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

Sets the value of access_system_security to the given value.

#Errors

If the given value is out of bounds for access_system_security. The ability to get or set the SACL in an object’s security descriptor.

Read more on MSDN - SACL Access Right

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

Returns the value of maximum_allowed. When requesting access, indicates that the caller wants maximum access rights.

Read more on MSDN - Requesting Access Rights to an Object

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

Returns the value of maximum_allowed.

#Errors

If the returned value contains an invalid bit pattern for maximum_allowed. When requesting access, indicates that the caller wants maximum access rights.

Read more on MSDN - Requesting Access Rights to an Object

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

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

#Panics

If the given value is out of bounds for maximum_allowed. When requesting access, indicates that the caller wants maximum access rights.

Read more on MSDN - Requesting Access Rights to an Object

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

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

#Errors

If the given value is out of bounds for maximum_allowed. When requesting access, indicates that the caller wants maximum access rights.

Read more on MSDN - Requesting Access Rights to an Object

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

Sets the value of maximum_allowed to the given value.

#Panics

If the given value is out of bounds for maximum_allowed. When requesting access, indicates that the caller wants maximum access rights.

Read more on MSDN - Requesting Access Rights to an Object

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

Sets the value of maximum_allowed to the given value.

#Errors

If the given value is out of bounds for maximum_allowed. When requesting access, indicates that the caller wants maximum access rights.

Read more on MSDN - Requesting Access Rights to an Object

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

Returns the value of generic_all. (generic) All possible access rights

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

Returns the value of generic_all.

#Errors

If the returned value contains an invalid bit pattern for generic_all. (generic) All possible access rights

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

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

#Panics

If the given value is out of bounds for generic_all. (generic) All possible access rights

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

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

#Errors

If the given value is out of bounds for generic_all. (generic) All possible access rights

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

Sets the value of generic_all to the given value.

#Panics

If the given value is out of bounds for generic_all. (generic) All possible access rights

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

Sets the value of generic_all to the given value.

#Errors

If the given value is out of bounds for generic_all. (generic) All possible access rights

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

Returns the value of generic_execute. (generic) Execute access

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

Returns the value of generic_execute.

#Errors

If the returned value contains an invalid bit pattern for generic_execute. (generic) Execute access

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

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

#Panics

If the given value is out of bounds for generic_execute. (generic) Execute access

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

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

#Errors

If the given value is out of bounds for generic_execute. (generic) Execute access

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

Sets the value of generic_execute to the given value.

#Panics

If the given value is out of bounds for generic_execute. (generic) Execute access

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

Sets the value of generic_execute to the given value.

#Errors

If the given value is out of bounds for generic_execute. (generic) Execute access

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

Returns the value of generic_write. (generic) Write access

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

Returns the value of generic_write.

#Errors

If the returned value contains an invalid bit pattern for generic_write. (generic) Write access

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

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

#Panics

If the given value is out of bounds for generic_write. (generic) Write access

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

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

#Errors

If the given value is out of bounds for generic_write. (generic) Write access

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

Sets the value of generic_write to the given value.

#Panics

If the given value is out of bounds for generic_write. (generic) Write access

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

Sets the value of generic_write to the given value.

#Errors

If the given value is out of bounds for generic_write. (generic) Write access

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

Returns the value of generic_read. (generic) Read access

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

Returns the value of generic_read.

#Errors

If the returned value contains an invalid bit pattern for generic_read. (generic) Read access

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

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

#Panics

If the given value is out of bounds for generic_read. (generic) Read access

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

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

#Errors

If the given value is out of bounds for generic_read. (generic) Read access

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

Sets the value of generic_read to the given value.

#Panics

If the given value is out of bounds for generic_read. (generic) Read access

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

Sets the value of generic_read to the given value.

#Errors

If the given value is out of bounds for generic_read. (generic) Read access

Trait Implementations

impl BinRead for AccessMask

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 AccessMask

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 AccessMask

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

impl Clone for AccessMask

fn clone(&self) -> AccessMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessMask

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

Formats the value using the given formatter.

impl Default for AccessMask

fn default() -> AccessMask

Returns the “default value” for a type.

impl PartialEq for AccessMask

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

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

The endianness of the type.

impl WriteEndian for AccessMask

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

The endianness of the type.

impl Copy for AccessMask

impl Eq for AccessMask

impl StructuralPartialEq for AccessMask