Skip to main content

Video

Struct Video 

Source
pub struct Video {
Show 16 fields pub kind: VideoKind, pub identifier: Option<String>, pub content: String, pub title: String, pub media: Vec<MediaAttachment>, pub published_at: Option<Timestamp>, pub alt: Option<String>, pub content_warning: Option<String>, pub duration_seconds: Option<f64>, pub text_tracks: Vec<TextTrack>, pub segments: Vec<Segment>, pub hashtags: Vec<String>, pub participants: Vec<VideoParticipant>, pub references: Vec<Url>, pub origin: Option<VideoOrigin>, pub extra_tags: Vec<Tag>,
}
Expand description

Typed bundle for a NIP-71 video event (any of the four kinds).

Fields§

§kind: VideoKind

Semantic kind.

§identifier: Option<String>

d identifier (required for addressable variants).

§content: String

.content — summary / description.

§title: String

title tag (required).

§media: Vec<MediaAttachment>

Media variants (at least one imeta tag).

§published_at: Option<Timestamp>

published_at Unix timestamp.

§alt: Option<String>

alt accessibility description.

§content_warning: Option<String>

content-warning reason.

§duration_seconds: Option<f64>

Top-level duration in seconds (used by the spec’s addressable example; the same value MAY also ride inside imeta).

§text_tracks: Vec<TextTrack>

text-track rows.

§segments: Vec<Segment>

segment chapters.

§hashtags: Vec<String>

t hashtags (lower-cased).

§participants: Vec<VideoParticipant>

p participants.

§references: Vec<Url>

r URL references.

§origin: Option<VideoOrigin>

origin import metadata.

§extra_tags: Vec<Tag>

Forward-compatible passthrough for unknown tags.

Implementations§

Source§

impl Video

Source

pub fn new( kind: VideoKind, title: impl Into<String>, media: MediaAttachment, ) -> Self

Construct a regular (non-addressable) video.

Source

pub fn identifier(self, identifier: impl Into<String>) -> Self

Set the d identifier (required for addressable kinds).

Source

pub fn content(self, content: impl Into<String>) -> Self

Set the .content body.

Source

pub fn media(self, media: MediaAttachment) -> Self

Append another media variant.

Source

pub const fn published_at(self, ts: Timestamp) -> Self

Source

pub fn alt(self, alt: impl Into<String>) -> Self

Set Self::alt.

Source

pub fn content_warning(self, warning: impl Into<String>) -> Self

Source

pub const fn duration_seconds(self, secs: f64) -> Self

Source

pub fn text_track(self, track: TextTrack) -> Self

Append a text track.

Source

pub fn segment(self, seg: Segment) -> Self

Append a segment.

Source

pub fn hashtag(self, tag: impl AsRef<str>) -> Self

Append a hashtag (lower-cased).

Source

pub fn participant(self, p: VideoParticipant) -> Self

Append a participant.

Source

pub fn reference(self, url: Url) -> Self

Append a reference URL.

Source

pub fn origin(self, origin: VideoOrigin) -> Self

Set the origin metadata.

Source

pub fn coordinate(&self, author: PublicKey) -> Option<Coordinate>

Build the addressable coordinate. Returns None for non-addressable kinds.

Source

pub fn from_event(event: &Event) -> Result<Self, VideoError>

Parse an NIP-71 event into a typed bundle.

§Errors

Trait Implementations§

Source§

impl Clone for Video

Source§

fn clone(&self) -> Video

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Video

Source§

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

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

impl PartialEq for Video

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Video

Auto Trait Implementations§

§

impl Freeze for Video

§

impl RefUnwindSafe for Video

§

impl Send for Video

§

impl Sync for Video

§

impl Unpin for Video

§

impl UnsafeUnpin for Video

§

impl UnwindSafe for Video

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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