Ssb.Types.Link

Documentation

data Link

A link to a message, feed, or blob.

Constructors

Link

Fields

• linkSigil :: Char

  sigil that starts the link, eg '@'

• linkTo :: Text

  thing being linked to (base64 encoded)

• linkTag :: Text

  hash or key algorithm of thing being linked to, eg "sha256"

Instances

Eq Link

Methods

(==) :: Link -> Link -> Bool

(/=) :: Link -> Link -> Bool

Ord Link

Methods

compare :: Link -> Link -> Ordering

(<) :: Link -> Link -> Bool

(<=) :: Link -> Link -> Bool

(>) :: Link -> Link -> Bool

(>=) :: Link -> Link -> Bool

max :: Link -> Link -> Link

min :: Link -> Link -> Link

Show Link

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

ToJSON Link

Methods

toJSON :: Link -> Value

toEncoding :: Link -> Encoding

toJSONList :: [Link] -> Value

toEncodingList :: [Link] -> Encoding

FromJSON Link

Methods

parseJSON :: Value -> Parser Link

parseJSONList :: Value -> Parser [Link]

parseLink :: Text -> Either String Link

Parses a Link eg "@LA9HYf5rnUJFHHTklKXLLRyrEytayjbFZRo76Aj/qKs=.ed25519"

formatLink :: Link -> Text

Formats a Link.

newtype FeedLink

A link to a feed.

Constructors

FeedLink

Fields

• unFeedLink :: PublicKey

Instances

Eq FeedLink

Methods

(==) :: FeedLink -> FeedLink -> Bool

(/=) :: FeedLink -> FeedLink -> Bool

Ord FeedLink

Methods

compare :: FeedLink -> FeedLink -> Ordering

(<) :: FeedLink -> FeedLink -> Bool

(<=) :: FeedLink -> FeedLink -> Bool

(>) :: FeedLink -> FeedLink -> Bool

(>=) :: FeedLink -> FeedLink -> Bool

max :: FeedLink -> FeedLink -> FeedLink

min :: FeedLink -> FeedLink -> FeedLink

Show FeedLink

Methods

showsPrec :: Int -> FeedLink -> ShowS

show :: FeedLink -> String

showList :: [FeedLink] -> ShowS

ToJSON FeedLink

Methods

toJSON :: FeedLink -> Value

toEncoding :: FeedLink -> Encoding

toJSONList :: [FeedLink] -> Value

toEncodingList :: [FeedLink] -> Encoding

FromJSON FeedLink

Methods

parseJSON :: Value -> Parser FeedLink

parseJSONList :: Value -> Parser [FeedLink]

IsLink FeedLink

Methods

fromLink :: Link -> Either String FeedLink

toLink :: FeedLink -> Link

toJSONLink :: FeedLink -> Value

fromJSONLink :: Value -> Parser FeedLink

newtype MessageLink

A link to a message.

Constructors

MessageLink

Fields

• unMessageLink :: Hash

Instances

Eq MessageLink

Methods

(==) :: MessageLink -> MessageLink -> Bool

(/=) :: MessageLink -> MessageLink -> Bool

Ord MessageLink

Methods

compare :: MessageLink -> MessageLink -> Ordering

(<) :: MessageLink -> MessageLink -> Bool

(<=) :: MessageLink -> MessageLink -> Bool

(>) :: MessageLink -> MessageLink -> Bool

(>=) :: MessageLink -> MessageLink -> Bool

max :: MessageLink -> MessageLink -> MessageLink

min :: MessageLink -> MessageLink -> MessageLink

Show MessageLink

Methods

showsPrec :: Int -> MessageLink -> ShowS

show :: MessageLink -> String

showList :: [MessageLink] -> ShowS

ToJSON MessageLink

Methods

toJSON :: MessageLink -> Value

toEncoding :: MessageLink -> Encoding

toJSONList :: [MessageLink] -> Value

toEncodingList :: [MessageLink] -> Encoding

FromJSON MessageLink

Methods

parseJSON :: Value -> Parser MessageLink

parseJSONList :: Value -> Parser [MessageLink]

IsLink MessageLink

Methods

fromLink :: Link -> Either String MessageLink

toLink :: MessageLink -> Link

toJSONLink :: MessageLink -> Value

fromJSONLink :: Value -> Parser MessageLink

newtype BlobLink

A link to a blob.

Constructors

BlobLink

Fields

• unBlobLink :: Hash

Instances

Eq BlobLink

Methods

(==) :: BlobLink -> BlobLink -> Bool

(/=) :: BlobLink -> BlobLink -> Bool

Ord BlobLink

Methods

compare :: BlobLink -> BlobLink -> Ordering

(<) :: BlobLink -> BlobLink -> Bool

(<=) :: BlobLink -> BlobLink -> Bool

(>) :: BlobLink -> BlobLink -> Bool

(>=) :: BlobLink -> BlobLink -> Bool

max :: BlobLink -> BlobLink -> BlobLink

min :: BlobLink -> BlobLink -> BlobLink

Show BlobLink

Methods

showsPrec :: Int -> BlobLink -> ShowS

show :: BlobLink -> String

showList :: [BlobLink] -> ShowS

ToJSON BlobLink

Methods

toJSON :: BlobLink -> Value

toEncoding :: BlobLink -> Encoding

toJSONList :: [BlobLink] -> Value

toEncodingList :: [BlobLink] -> Encoding

FromJSON BlobLink

Methods

parseJSON :: Value -> Parser BlobLink

parseJSONList :: Value -> Parser [BlobLink]

IsLink BlobLink

Methods

fromLink :: Link -> Either String BlobLink

toLink :: BlobLink -> Link

toJSONLink :: BlobLink -> Value

fromJSONLink :: Value -> Parser BlobLink

class IsLink t where

Class of types that are links.

Minimal complete definition

fromLink, toLink

Methods

fromLink :: Link -> Either String t

toLink :: t -> Link

toJSONLink :: t -> Value

fromJSONLink :: Value -> Parser t

Instances

IsLink BlobLink

Methods

fromLink :: Link -> Either String BlobLink

toLink :: BlobLink -> Link

toJSONLink :: BlobLink -> Value

fromJSONLink :: Value -> Parser BlobLink

IsLink MessageLink

Methods

fromLink :: Link -> Either String MessageLink

toLink :: MessageLink -> Link

toJSONLink :: MessageLink -> Value

fromJSONLink :: Value -> Parser MessageLink

IsLink FeedLink

Methods

fromLink :: Link -> Either String FeedLink

toLink :: FeedLink -> Link

toJSONLink :: FeedLink -> Value

fromJSONLink :: Value -> Parser FeedLink