Struct ScsiCommandRequest 

pub struct ScsiCommandRequest {
    pub opcode: RawBhsOpcode,
    pub flags: RawScsiCmdReqFlags,
    pub total_ahs_length: u8,
    pub data_segment_length: [u8; 3],
    pub lun: LogicalUnitNumber,
    pub initiator_task_tag: InitiatorTaskTag,
    pub expected_data_transfer_length: U32<BigEndian>,
    pub cmd_sn: U32<BigEndian>,
    pub exp_stat_sn: U32<BigEndian>,
    pub scsi_descriptor_block: [u8; 16],
    /* private fields */
}

Basic Header Segment for iSCSI SCSI Command Request PDU

Represents the 48-byte header structure for SCSI Command PDU as defined in RFC 7143. Contains all the fields necessary to send a SCSI command over iSCSI including task tags, sequence numbers, LUN, and the embedded SCSI CDB.

Fields

opcode: RawBhsOpcode

PDU opcode (byte 0) - should be 0x01 for SCSI Command

flags: RawScsiCmdReqFlags

Command flags (byte 1) - Final, Read, Write bits and task attributes

total_ahs_length: u8

Total Additional Header Segments length (byte 4)

data_segment_length: [u8; 3]

Data Segment Length (bytes 5-7) - length of immediate data

lun: LogicalUnitNumber

Logical Unit Number (bytes 8-15)

initiator_task_tag: InitiatorTaskTag

Initiator Task Tag (bytes 16-19) - unique command identifier

expected_data_transfer_length: U32<BigEndian>

Expected Data Transfer Length (bytes 20-23) - total data expected

cmd_sn: U32<BigEndian>

Command Sequence Number (bytes 24-27) - for ordering

exp_stat_sn: U32<BigEndian>

Expected Status Sequence Number (bytes 28-31) - acknowledgment

scsi_descriptor_block: [u8; 16]

SCSI Command Descriptor Block (bytes 32-47) - the actual SCSI command

Implementations

impl ScsiCommandRequest

pub const DEFAULT_TAG: u32 = 0xffffffff_u32

The default initiator task tag value.

pub fn to_bhs_bytes(&self, buf: &mut [u8]) -> Result<()>

Serializes the BHS into a byte buffer.

pub fn from_bhs_bytes(buf: &mut [u8]) -> Result<&mut Self>

Deserializes the BHS from a byte buffer.

Trait Implementations

impl BasicHeaderSegment for ScsiCommandRequest

fn to_bhs_bytes(&self, buf: &mut [u8]) -> Result<()>

fn get_opcode(&self) -> Result<BhsOpcode>

first u8 of BHS

fn get_initiator_task_tag(&self) -> u32

Expose Initiator Task Tag of this PDU

fn get_ahs_length_bytes(&self) -> usize

Number of extra AHS bytes (always a multiple of 4).

fn set_ahs_length_bytes(&mut self, len: u8)

Number of extra AHS bytes (always a multiple of 4).

fn get_data_length_bytes(&self) -> usize

Get number of actual payload bytes in the DataSegment.

fn set_data_length_bytes(&mut self, len: u32)

Set number of actual payload bytes in the DataSegment.

fn total_length_bytes(&self) -> usize

Number of actual payload bytes in the DataSegment.

fn get_header_diggest(&self, enable_header_digest: bool) -> usize

fn get_data_diggest(&self, enable_data_digest: bool) -> usize

impl Debug for ScsiCommandRequest

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

Formats the value using the given formatter.

impl Default for ScsiCommandRequest

fn default() -> ScsiCommandRequest

Returns the “default value” for a type.

impl<'a> From<&'a mut ScsiCommandRequest> for Pdu<'a>

fn from(v: &'a mut ScsiCommandRequest) -> Pdu<'a>

Converts to this type from the input type.

impl FromBytes for ScsiCommandRequest

where RawBhsOpcode: FromBytes, RawScsiCmdReqFlags: FromBytes, [u8; 2]: FromBytes, u8: FromBytes, [u8; 3]: FromBytes, LogicalUnitNumber: FromBytes, InitiatorTaskTag: FromBytes, U32<BigEndian>: FromBytes, [u8; 16]: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromBytes for ScsiCommandRequest

fn from_bhs_bytes(bytes: &mut [u8]) -> Result<&mut Self>

Parse the full PDU from a contiguous byte buffer.

impl FromZeros for ScsiCommandRequest

where RawBhsOpcode: FromZeros, RawScsiCmdReqFlags: FromZeros, [u8; 2]: FromZeros, u8: FromZeros, [u8; 3]: FromZeros, LogicalUnitNumber: FromZeros, InitiatorTaskTag: FromZeros, U32<BigEndian>: FromZeros, [u8; 16]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Immutable for ScsiCommandRequest

where RawBhsOpcode: Immutable, RawScsiCmdReqFlags: Immutable, [u8; 2]: Immutable, u8: Immutable, [u8; 3]: Immutable, LogicalUnitNumber: Immutable, InitiatorTaskTag: Immutable, U32<BigEndian>: Immutable, [u8; 16]: Immutable,

impl IntoBytes for ScsiCommandRequest

where RawBhsOpcode: IntoBytes, RawScsiCmdReqFlags: IntoBytes, [u8; 2]: IntoBytes, u8: IntoBytes, [u8; 3]: IntoBytes, LogicalUnitNumber: IntoBytes, InitiatorTaskTag: IntoBytes, U32<BigEndian>: IntoBytes, [u8; 16]: IntoBytes, (): PaddingFree<Self, { _ }>,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for ScsiCommandRequest

where [u8; 16]: KnownLayout,

type PointerMetadata = <[u8; 16] as KnownLayout>::PointerMetadata

The type of metadata stored in a pointer to Self.

fn size_for_metadata(meta: Self::PointerMetadata) -> Option<usize>

Computes the size of an object of type Self with the given pointer metadata.

impl PartialEq for ScsiCommandRequest

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

fn get_final_bit(&self) -> bool

Return the current state of the Final (F) bit.

fn set_final_bit(&mut self)

Force F = 1 (and, if your PDU has it, clear C).

fn get_continue_bit(&self) -> bool

Return the current state of the Continue (C) bit.

fn set_continue_bit(&mut self)

Force C = 1 (and clear F).

impl StructuralPartialEq for ScsiCommandRequest

impl TryFromBytes for ScsiCommandRequest

where RawBhsOpcode: TryFromBytes, RawScsiCmdReqFlags: TryFromBytes, [u8; 2]: TryFromBytes, u8: TryFromBytes, [u8; 3]: TryFromBytes, LogicalUnitNumber: TryFromBytes, InitiatorTaskTag: TryFromBytes, U32<BigEndian>: TryFromBytes, [u8; 16]: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl<'a> TryInto<&'a mut ScsiCommandRequest> for Pdu<'a>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<&'a mut ScsiCommandRequest, <Self as TryInto<&'a mut ScsiCommandRequest>>::Error>

Performs the conversion.

impl ZeroCopyType for ScsiCommandRequest