Exosphere.Bsky.Richtext.Facet (Exosphere v0.6.0)

Copy Markdown View Source

Annotation of a sub-string within rich text.

Object schema app.bsky.richtext.facet.

Fields

  • features: array
  • index: ref #byteSlice

Summary

Types

t()

Functions

from_map(map)

Decode a wire-format map. Delegates to new/1.

new(attrs)

Build and validate from a map of attrs (atom or wire string keys).

new!(attrs)

Build and validate, raising ArgumentError on error.

to_map(struct)

Encode to the wire-format map.

type_id()

The lexicon type ID (nsid or nsid#def) this module was generated from.

Types

t()

@type t() :: %Exosphere.Bsky.Richtext.Facet{
  extra: term(),
  features: [
    Exosphere.Bsky.Richtext.Facet.Mention.t()
    | Exosphere.Bsky.Richtext.Facet.Link.t()
    | Exosphere.Bsky.Richtext.Facet.Tag.t()
    | map()
  ],
  index: Exosphere.Bsky.Richtext.Facet.ByteSlice.t()
}

Functions

from_map(map)

@spec from_map(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Decode a wire-format map. Delegates to new/1.

new(attrs)

@spec new(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Build and validate from a map of attrs (atom or wire string keys).

Unknown keys are kept in extra and re-emitted by to_map/1.

new!(attrs)

@spec new!(map()) :: t()

Build and validate, raising ArgumentError on error.

to_map(struct)

@spec to_map(t()) :: map()

Encode to the wire-format map.

type_id()

@spec type_id() :: String.t()

The lexicon type ID (nsid or nsid#def) this module was generated from.