Struct FileMetadata 

pub struct FileMetadata {

    pub url: Option<Url>,
    pub mime_type: Option<String>,
    pub hash: Option<[u8; 32]>,
    pub original_hash: Option<[u8; 32]>,
    pub size: Option<u64>,
    pub dim: Option<ImageDimensions>,
    pub magnet: Option<String>,
    pub torrent_infohash: Option<String>,
    pub blurhash: Option<String>,
    pub thumb: Option<FileVariant>,
    pub preview_image: Option<FileVariant>,
    pub summary: Option<String>,
    pub alt: Option<String>,
    pub fallback_urls: Vec<Url>,
    pub service: Option<String>,
}

Typed bundle of every NIP-94 field.

Build incrementally with Self::new + the chainable setters, or hydrate from a wire event with Self::from_event.

Fields

url: Option<Url>

Download URL (url tag — required).

mime_type: Option<String>

MIME type (m tag — required).

hash: Option<[u8; 32]>

SHA-256 of the served bytes (x tag — required).

original_hash: Option<[u8; 32]>

SHA-256 of the original bytes before any server-side transformation (ox tag).

size: Option<u64>

File size in bytes (size tag).

dim: Option<ImageDimensions>

Pixel dimensions (dim tag).

magnet: Option<String>

Magnet URI (magnet tag).

torrent_infohash: Option<String>

Torrent infohash (i tag).

blurhash: Option<String>

Blurhash placeholder (blurhash tag).

thumb: Option<FileVariant>

Thumbnail variant (thumb tag).

preview_image: Option<FileVariant>

Preview image variant (image tag).

summary: Option<String>

Text excerpt (summary tag).

alt: Option<String>

Accessibility description (alt tag).

fallback_urls: Vec<Url>

Zero or more fallback download URLs (fallback tags).

service: Option<String>

Serving-service identifier such as nip96 (service tag).

Implementations

impl FileMetadata

pub fn new(url: Url, mime_type: impl Into<String>, hash: [u8; 32]) -> Self

Construct with the three required fields.

pub const fn original_hash(self, hash: [u8; 32]) -> Self

Set Self::original_hash.

pub const fn size(self, size: u64) -> Self

Set Self::size.

pub const fn dim(self, dim: ImageDimensions) -> Self

Set Self::dim.

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

Set Self::magnet.

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

Set Self::torrent_infohash.

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

Set Self::blurhash.

pub fn thumb(self, thumb: FileVariant) -> Self

Set Self::thumb.

pub fn preview_image(self, image: FileVariant) -> Self

Set Self::preview_image.

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

Set Self::summary.

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

Set Self::alt.

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

Append one fallback URL.

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

Set Self::service.

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

Parse a kind: 1063 event back into a typed bundle.

Errors

• FileMetadataError::WrongKind for any other kind.
• FileMetadataError::MissingUrl / MissingMimeType / MissingHash when the corresponding required tag is absent.
• FileMetadataError::InvalidUrl / InvalidHash / InvalidSize / InvalidDim when the value is present but malformed.

pub fn from_tags(tags: &Tags) -> Result<Self, FileMetadataError>

Parse a tag list (without requiring a wrapping event). Useful when callers already know the event kind matches and only want the metadata reconstruction.

Errors

See Self::from_event.

pub fn to_tags(&self) -> Result<Vec<Tag>, FileMetadataError>

Materialise the bundle into a Vec<Tag> ready for use with EventBuilder::tag / EventBuilder::tags. Required fields must be set; missing required fields produce an Err(FileMetadataError::Missing*) so authoring stays symmetric with reading.

Errors

Returns the corresponding Missing* error when a required field is unset.

Trait Implementations

impl Clone for FileMetadata

fn clone(&self) -> FileMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetadata

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

Formats the value using the given formatter.

impl Default for FileMetadata

fn default() -> FileMetadata

Returns the “default value” for a type.

impl Eq for FileMetadata

impl PartialEq for FileMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileMetadata