Skip to main content

MediaSource

Struct MediaSource 

Source
pub struct MediaSource<R> { /* private fields */ }
Expand description

MediaSource represents a media data source that can be parsed by MediaParser.

Note: Please use MediaSource::seekable in preference to MediaSource::unseekable, since the former is more efficient when the parser needs to skip a large number of bytes.

Passing in a BufRead should be avoided because MediaParser comes with its own buffer management and the buffers can be shared between multiple parsing tasks, thus avoiding frequent memory allocations.

Implementations§

Source§

impl<R> MediaSource<R>

Source

pub fn kind(&self) -> MediaKind

Top-level classification of this media source.

Source§

impl<R: Read> MediaSource<R>

Source

pub fn unseekable(reader: R) -> Result<Self>

Use MediaSource::unseekable to create a MediaSource from a reader that only impl Read

Note: Please use MediaSource::seekable in preference to MediaSource::unseekable, since the former is more efficient when the parser needs to skip a large number of bytes.

Source§

impl<R: Read + Seek> MediaSource<R>

Source

pub fn seekable(reader: R) -> Result<Self>

Use MediaSource::seekable to create a MediaSource from a Read + Seek

Note: Please use MediaSource::seekable in preference to MediaSource::unseekable, since the former is more efficient when the parser needs to skip a large number of bytes.

Source§

impl MediaSource<File>

Source

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a file at path and parse its header to detect the media format.

This is the v3-preferred entry point for the common case of “I have a path on disk”. For an already-open File use Self::seekable.

Source§

impl MediaSource<()>

Source

pub fn from_bytes(bytes: impl Into<Bytes>) -> Result<Self>

Build a MediaSource from an in-memory byte payload.

Accepts any type convertible into bytes::BytesBytes, Vec<u8>, &'static [u8], bytes::Bytes::from_owner outputs, and HTTP-stack body types that implement Into<Bytes> directly.

The header (first up to 128 bytes) is sniffed for media kind, the same way MediaSource::open does it for files. The full payload is stored zero-copy: subsequent parsing through MediaParser::parse_exif_from_bytes / MediaParser::parse_track_from_bytes shares this Bytes directly with the returned ExifIter / sub-IFDs via reference counting.

The returned source is parsed by the dedicated MediaParser::parse_exif_from_bytes / MediaParser::parse_track_from_bytes methods. The streaming parse_exif / parse_track methods do not accept MediaSource<()> (their R: Read bound is unsatisfiable).

§Example
use nom_exif::{MediaSource, MediaParser, MediaKind};

let bytes = std::fs::read("./testdata/exif.jpg")?;
let ms = MediaSource::from_bytes(bytes)?;
assert_eq!(ms.kind(), MediaKind::Image);

let mut parser = MediaParser::new();
let _iter = parser.parse_exif_from_bytes(ms)?;

Trait Implementations§

Source§

impl<R> Debug for MediaSource<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> !Freeze for MediaSource<R>

§

impl<R> RefUnwindSafe for MediaSource<R>
where R: RefUnwindSafe,

§

impl<R> Send for MediaSource<R>
where R: Send,

§

impl<R> Sync for MediaSource<R>
where R: Sync,

§

impl<R> Unpin for MediaSource<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for MediaSource<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for MediaSource<R>
where R: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more