Struct ScsiCommandResponse 

pub struct ScsiCommandResponse {

    pub opcode: RawBhsOpcode,
    pub flags: RawScsiCmdRespFlags,
    pub response: RawResponseCode,
    pub status: RawScsiStatus,
    pub total_ahs_length: u8,
    pub data_segment_length: [u8; 3],
    pub initiator_task_tag: InitiatorTaskTag,
    pub snack_tag: U32<BigEndian>,
    pub stat_sn: U32<BigEndian>,
    pub exp_cmd_sn: U32<BigEndian>,
    pub max_cmd_sn: U32<BigEndian>,
    pub exp_data_sn: U32<BigEndian>,
    pub bidirectional_read_residual_count: U32<BigEndian>,
    pub residual_count: U32<BigEndian>,
    /* private fields */
}

Basic Header Segment for iSCSI SCSI Command Response PDU

Represents the 48-byte header structure for SCSI Command Response PDU as defined in RFC 7143. Contains response status, sequence numbers, residual counts, and other information returned by the target after executing a SCSI command.

Fields

opcode: RawBhsOpcode

PDU opcode (byte 0) - should be 0x21 for SCSI Response

flags: RawScsiCmdRespFlags

Response flags (byte 1) - Final bit and residual overflow/underflow indicators

response: RawResponseCode

Response code (byte 2) - indicates if command completed successfully

status: RawScsiStatus

SCSI status (byte 3) - SCSI command execution status

total_ahs_length: u8

Total Additional Header Segments length (byte 4)

data_segment_length: [u8; 3]

Data Segment Length (bytes 5-7) - length of sense data or other response data

initiator_task_tag: InitiatorTaskTag

Initiator Task Tag (bytes 16-19) - matches the original command ITT

snack_tag: U32<BigEndian>

SNACK Tag (bytes 20-23) - used for data recovery

stat_sn: U32<BigEndian>

Status Sequence Number (bytes 24-27) - sequence number for this response

exp_cmd_sn: U32<BigEndian>

Expected Command Sequence Number (bytes 28-31) - next expected command

max_cmd_sn: U32<BigEndian>

Maximum Command Sequence Number (bytes 32-35) - command window limit

exp_data_sn: U32<BigEndian>

Expected Data Sequence Number (bytes 36-39) - for data recovery

bidirectional_read_residual_count: U32<BigEndian>

Bidirectional Read Residual Count (bytes 40-43) - unused read data length

residual_count: U32<BigEndian>

Residual Count (bytes 44-47) - difference between expected and actual data transfer

Implementations

impl ScsiCommandResponse

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.

pub fn residual_valid(&self) -> bool

Checks if the residual count is valid.

pub fn residual_effective(&self) -> u32

Returns the effective residual count.

pub fn bidi_read_residual_valid(&self) -> bool

Checks if the bidirectional read residual count is valid.

pub fn bidi_read_residual_effective(&self) -> u32

Returns the effective bidirectional read residual count.

Trait Implementations

impl BasicHeaderSegment for ScsiCommandResponse

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 ScsiCommandResponse

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl FromBytes for ScsiCommandResponse

where RawBhsOpcode: FromBytes, RawScsiCmdRespFlags: FromBytes, RawResponseCode: FromBytes, RawScsiStatus: FromBytes, u8: FromBytes, [u8; 3]: FromBytes, [u8; 8]: FromBytes, InitiatorTaskTag: FromBytes, U32<BigEndian>: 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 ScsiCommandResponse

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

Parse the full PDU from a contiguous byte buffer.

impl FromZeros for ScsiCommandResponse

where RawBhsOpcode: FromZeros, RawScsiCmdRespFlags: FromZeros, RawResponseCode: FromZeros, RawScsiStatus: FromZeros, u8: FromZeros, [u8; 3]: FromZeros, [u8; 8]: FromZeros, InitiatorTaskTag: FromZeros, U32<BigEndian>: 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 ScsiCommandResponse

where RawBhsOpcode: Immutable, RawScsiCmdRespFlags: Immutable, RawResponseCode: Immutable, RawScsiStatus: Immutable, u8: Immutable, [u8; 3]: Immutable, [u8; 8]: Immutable, InitiatorTaskTag: Immutable, U32<BigEndian>: Immutable,

impl IntoBytes for ScsiCommandResponse

where RawBhsOpcode: IntoBytes, RawScsiCmdRespFlags: IntoBytes, RawResponseCode: IntoBytes, RawScsiStatus: IntoBytes, u8: IntoBytes, [u8; 3]: IntoBytes, [u8; 8]: IntoBytes, InitiatorTaskTag: IntoBytes, U32<BigEndian>: 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 ScsiCommandResponse

where U32<BigEndian>: KnownLayout,

type PointerMetadata = <U32<BigEndian> 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 ScsiCommandResponse

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

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 ScsiCommandResponse

impl TryFromBytes for ScsiCommandResponse

where RawBhsOpcode: TryFromBytes, RawScsiCmdRespFlags: TryFromBytes, RawResponseCode: TryFromBytes, RawScsiStatus: TryFromBytes, u8: TryFromBytes, [u8; 3]: TryFromBytes, [u8; 8]: TryFromBytes, InitiatorTaskTag: TryFromBytes, U32<BigEndian>: 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 ScsiCommandResponse> for Pdu<'a>

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ZeroCopyType for ScsiCommandResponse