Struct pdb::StreamIndex

pub struct StreamIndex(pub u16);

Index of a PDB stream.

This index can either refer to a stream, or indicate the absence of a stream. Check is_none to see whether a stream should exist.

Use get to load data for this stream.

Implementations

impl StreamIndex

pub const fn none() -> Self

Returns an index that points to no value.

#[must_use]pub fn is_some(self) -> bool

Returns true if the index points to a valid value.

#[must_use]pub fn is_none(self) -> bool

Returns true if the index indicates the absence of a value.

impl StreamIndex

pub fn get<'s, S>(self, pdb: &mut PDB<'s, S>) -> Result<Option<Stream<'s>>> where
    S: Source<'s> + 's, 

Load the raw data of this stream from the PDB.

Returns None if this index is none. Otherwise, this will try to read the stream from the PDB, which might fail if the stream is missing.

Errors

• Error::StreamNotFound if the PDB does not contain this stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt

Trait Implementations

impl Clone for StreamIndex

fn clone(&self) -> StreamIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StreamIndex

impl Debug for StreamIndex

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

Formats the value using the given formatter.

impl Default for StreamIndex

fn default() -> Self

Returns the “default value” for a type.

impl Display for StreamIndex

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

Formats the value using the given formatter.

impl Eq for StreamIndex

impl Hash for StreamIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for StreamIndex

fn cmp(&self, other: &StreamIndex) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<StreamIndex> for StreamIndex

fn eq(&self, other: &StreamIndex) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StreamIndex) -> bool

This method tests for !=.

impl PartialOrd<StreamIndex> for StreamIndex

fn partial_cmp(&self, other: &StreamIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for StreamIndex

impl StructuralPartialEq for StreamIndex

impl<'a> TryFromCtx<'a, Endian, [u8]> for StreamIndex

type Error = Error

fn try_from_ctx(this: &'a [u8], le: Endian) -> Result<(Self, usize)>