Struct ScsiDataIn 

#[repr(C)]
pub struct ScsiDataIn {

    pub opcode: RawBhsOpcode,
    pub flags: RawDataInFlags,
    pub reserved2: u8,
    pub status_or_rsvd: RawScsiStatus,
    pub total_ahs_length: u8,
    pub data_segment_length: [u8; 3],
    pub lun: LogicalUnitNumber,
    pub initiator_task_tag: InitiatorTaskTag,
    pub target_transfer_tag: U32<BigEndian>,
    pub stat_sn_or_rsvd: U32<BigEndian>,
    pub exp_cmd_sn: U32<BigEndian>,
    pub max_cmd_sn: U32<BigEndian>,
    pub data_sn: U32<BigEndian>,
    pub buffer_offset: U32<BigEndian>,
    pub residual_count: U32<BigEndian>,
}

Represents the Basic Header Segment (BHS) for a SCSI Data-In PDU (opcode 0x25).

Fields

opcode: RawBhsOpcode

flags: RawDataInFlags

reserved2: u8

status_or_rsvd: RawScsiStatus

total_ahs_length: u8

data_segment_length: [u8; 3]

lun: LogicalUnitNumber

initiator_task_tag: InitiatorTaskTag

target_transfer_tag: U32<BigEndian>

stat_sn_or_rsvd: U32<BigEndian>

exp_cmd_sn: U32<BigEndian>

max_cmd_sn: U32<BigEndian>

data_sn: U32<BigEndian>

buffer_offset: U32<BigEndian>

residual_count: U32<BigEndian>

Implementations

impl ScsiDataIn

pub fn scsi_status(&self) -> Option<ScsiStatus>

Returns the decoded SCSI status if the Status (S) bit is set.

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 set_scsi_status(&mut self, st: Option<ScsiStatus>)

Sets the SCSI status and updates the S and F flags accordingly.

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

Serializes the BHS into a byte buffer, zeroing out fields as required.

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

Deserializes the BHS from a byte buffer.

pub fn get_real_final_bit(&self) -> bool

Returns the actual value of the Final (F) bit.

pub fn get_status_bit(&self) -> bool

Returns the value of the Status (S) bit.

Trait Implementations

impl BasicHeaderSegment for ScsiDataIn

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_bytes: 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 ScsiDataIn

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

Formats the value using the given formatter.

impl Default for ScsiDataIn

fn default() -> ScsiDataIn

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl FromBytes for ScsiDataIn

where RawBhsOpcode: FromBytes, RawDataInFlags: FromBytes, u8: FromBytes, RawScsiStatus: FromBytes, [u8; 3]: FromBytes, LogicalUnitNumber: 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 ScsiDataIn

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

Parse the full PDU from a contiguous byte buffer.

impl FromZeros for ScsiDataIn

where RawBhsOpcode: FromZeros, RawDataInFlags: FromZeros, u8: FromZeros, RawScsiStatus: FromZeros, [u8; 3]: FromZeros, LogicalUnitNumber: 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 ScsiDataIn

where RawBhsOpcode: Immutable, RawDataInFlags: Immutable, u8: Immutable, RawScsiStatus: Immutable, [u8; 3]: Immutable, LogicalUnitNumber: Immutable, InitiatorTaskTag: Immutable, U32<BigEndian>: Immutable,

impl IntoBytes for ScsiDataIn

where RawBhsOpcode: IntoBytes, RawDataInFlags: IntoBytes, u8: IntoBytes, RawScsiStatus: IntoBytes, [u8; 3]: IntoBytes, LogicalUnitNumber: 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 ScsiDataIn

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 ScsiDataIn

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

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 ScsiDataIn

impl TryFromBytes for ScsiDataIn

where RawBhsOpcode: TryFromBytes, RawDataInFlags: TryFromBytes, u8: TryFromBytes, RawScsiStatus: TryFromBytes, [u8; 3]: TryFromBytes, LogicalUnitNumber: 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 ScsiDataIn> for Pdu<'a>

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ZeroCopyType for ScsiDataIn