Struct nostr_types::FileMetadata

pub struct FileMetadata {

    pub url: UncheckedUrl,
    pub m: Option<String>,
    pub x: Option<String>,
    pub ox: Option<String>,
    pub size: Option<u64>,
    pub dim: Option<(usize, usize)>,
    pub magnet: Option<UncheckedUrl>,
    pub i: Option<String>,
    pub blurhash: Option<String>,
    pub thumb: Option<UncheckedUrl>,
    pub image: Option<UncheckedUrl>,
    pub summary: Option<String>,
    pub alt: Option<String>,
    pub fallback: Vec<UncheckedUrl>,
    pub service: Option<String>,
}

NIP-92/94 File Metadata

Fields

url: UncheckedUrl

The URL this metadata applies to

m: Option<String>

Mime type (lowercase), see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types

x: Option<String>

SHA-256 hex-encoded hash

ox: Option<String>

original SHA-256 hex-encoded hash prior to transformations

size: Option<u64>

Size of file in bytes

dim: Option<(usize, usize)>

Dimensions of the image

magnet: Option<UncheckedUrl>

Magnet URI

i: Option<String>

Torrent infohash

blurhash: Option<String>

Blurhash

thumb: Option<UncheckedUrl>

Thumbnail URL

image: Option<UncheckedUrl>

Preview image (same dimensions)

summary: Option<String>

Summary text

alt: Option<String>

Alt description

fallback: Vec<UncheckedUrl>

Fallback URLs

service: Option<String>

Service

Implementations

impl FileMetadata

pub fn new(url: UncheckedUrl) -> FileMetadata

Create a new empty (except the URL) FileMetadata

pub fn to_nip94_preevent(&self, pubkey: PublicKey) -> PreEvent

Create a NIP-94 FileMetadata PreEvent from this FileMetadata

pub fn from_nip94_event(event: &Event) -> Option<FileMetadata>

Turn a kind-1063 (FileMetadata) event into a FileMetadata structure

pub fn to_imeta_tag(&self) -> Tag

Convert into an ‘imeta’ tag

pub fn from_imeta_tag(tag: &Tag) -> Option<FileMetadata>

Import from an ‘imeta’ tag

Trait Implementations

impl Clone for FileMetadata

fn clone(&self) -> FileMetadata

Returns a copy 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 Hash for FileMetadata

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileMetadata

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FileMetadata