dicom_core::value

Struct PixelFragmentSequence

Source
pub struct PixelFragmentSequence<P> { /* private fields */ }
Expand description

A sequence of pixel data fragments.

Each fragment (of data type P) is an even-lengthed sequence of bytes representing the encoded pixel data. The first item of the sequence is interpreted as a basic offset table, which is defined separately.

Implementations§

Source§

impl<P> PixelFragmentSequence<P>

Source

pub fn new(offset_table: impl Into<C<u32>>, fragments: impl Into<C<P>>) -> Self

Construct a DICOM pixel sequence sequence value from a basic offset table and a list of fragments.

Note: This function does not validate the offset table against the given fragments.

Source

pub fn new_fragments(fragments: impl Into<C<P>>) -> Self

Construct a DICOM pixel sequence sequence value from a list of fragments, with an empty basic offset table.

Source

pub fn fragments(&self) -> &[P]

Gets a reference to the pixel data fragments.

This sequence does not include the offset table.

Source

pub fn fragments_mut(&mut self) -> &mut C<P>

Gets a mutable reference to the pixel data fragments.

This sequence does not include the offset table.

Source

pub fn into_fragments(self) -> C<P>

Retrieve the pixel data fragments, discarding the rest of the information.

This sequence does not include the offset table.

Source

pub fn into_parts(self) -> (C<u32>, C<P>)

Decompose the sequence into its constituent parts: the basic offset table and the pixel data fragments.

Source

pub fn offset_table(&self) -> &[u32]

Gets a reference to the encapsulated pixel data’s offset table.

Source

pub fn offset_table_mut(&mut self) -> &mut C<u32>

Gets a mutable reference to the encapsulated pixel data’s offset table.

Source

pub fn length(&self) -> Length

Get the value data’s length as specified by the sequence’s data element, in bytes.

This is equivalent to HasLength::length.

Source

pub fn truncate(&mut self, limit: usize)

Shorten this sequence by removing trailing fragments to fit the given limit.

Note that this operations does not affect the basic offset table.

Trait Implementations§

Source§

impl<P: Clone> Clone for PixelFragmentSequence<P>

Source§

fn clone(&self) -> PixelFragmentSequence<P>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P: Debug> Debug for PixelFragmentSequence<P>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<P> DicomValueType for PixelFragmentSequence<P>

Source§

fn value_type(&self) -> ValueType

Retrieve the specific type of this value.
Source§

fn cardinality(&self) -> usize

Retrieve the number of elements contained in the DICOM value. Read more
Source§

impl<T, F, P> From<(T, F)> for PixelFragmentSequence<P>
where T: Into<C<u32>>, F: Into<C<P>>,

Source§

fn from((offset_table, fragments): (T, F)) -> Self

Construct a pixel data fragment sequence, interpreting the first tuple element as a basic offset table and the second element as the vector of fragments.

Note: This function does not validate the offset table against the given fragments.

Source§

impl<I, P> From<PixelFragmentSequence<P>> for Value<I, P>

Source§

fn from(value: PixelFragmentSequence<P>) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<Fragments>> for PixelFragmentSequence<InMemFragment>

Source§

fn from(value: Vec<Fragments>) -> Self

Converts to this type from the input type.
Source§

impl<P> HasLength for PixelFragmentSequence<P>

Source§

fn length(&self) -> Length

In standard DICOM, encapsulated pixel data is always defined by a pixel data element with an undefined length.

Source§

fn is_empty(&self) -> bool

Check whether the value is empty (0 length).
Source§

impl<P: PartialEq> PartialEq for PixelFragmentSequence<P>

Source§

fn eq(&self, other: &PixelFragmentSequence<P>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<P> StructuralPartialEq for PixelFragmentSequence<P>

Auto Trait Implementations§

§

impl<P> Freeze for PixelFragmentSequence<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for PixelFragmentSequence<P>
where P: RefUnwindSafe,

§

impl<P> Send for PixelFragmentSequence<P>
where P: Send,

§

impl<P> Sync for PixelFragmentSequence<P>
where P: Sync,

§

impl<P> Unpin for PixelFragmentSequence<P>
where P: Unpin,

§

impl<P> UnwindSafe for PixelFragmentSequence<P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.