Struct CodeSnippet 

pub struct CodeSnippet {
    pub content: String,
    pub language: Option<String>,
    pub name: Option<String>,
    pub extension: Option<String>,
    pub description: Option<String>,
    pub runtime: Option<String>,
    pub licenses: Vec<String>,
    pub dependencies: Vec<String>,
    pub repos: Vec<CodeRepo>,
    pub extra_tags: Vec<Tag>,
}

Typed bundle for a kind: 1337 code-snippet event.

Fields

content: String

The actual code body.

language: Option<String>

l programming language token (lower-case per spec).

name: Option<String>

name (commonly a filename).

extension: Option<String>

extension (without the leading dot).

description: Option<String>

description line.

runtime: Option<String>

runtime specifier.

licenses: Vec<String>

license SPDX identifiers (multi-licensing supported).

dependencies: Vec<String>

dep dependency lines (repeatable).

repos: Vec<CodeRepo>

repo references (URL or NIP-34 coordinate).

extra_tags: Vec<Tag>

Forward-compatible passthrough for unknown tags.

Implementations

impl CodeSnippet

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

Construct a code snippet with the body seeded.

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

Parse a kind: 1337 code-snippet event.

Errors

See CodeSnippetError for the failure modes.

Trait Implementations

impl Clone for CodeSnippet

fn clone(&self) -> CodeSnippet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeSnippet

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

Formats the value using the given formatter.

impl Default for CodeSnippet

fn default() -> CodeSnippet

Returns the “default value” for a type.

impl Eq for CodeSnippet

impl PartialEq for CodeSnippet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodeSnippet