eventid

Documentation

Index

• type T
  • func Gen() (ei *T)
  • func New() (ei *T)
  • func NewFromBytes(b []byte) (ei *T, err error)
  • func NewFromString(s string) (ei *T, err error)
  • func NewWith[V string | []byte](s V) (ei *T)
  • func (ei *T) ByteString(src []byte) (b []byte)
  • func (ei *T) Bytes() (b []byte)
  • func (ei *T) Equal(ei2 *T) (eq bool)
  • func (ei *T) Len() int
  • func (ei *T) Marshal(dst []byte) (b []byte)
  • func (ei *T) Set(b []byte) (err error)
  • func (ei *T) String() string
  • func (ei *T) Unmarshal(b []byte) (rem []byte, err error)

Types

type T

type T [sha256.Size]byte

T is the SHA256 hash in hexadecimal of the canonical form of an event as produced by the output of T.ToCanonical().Bytes().

func Gen

func Gen() (ei *T)

Gen creates a fake pseudorandom generated event ID for tests.

func New

func New() (ei *T)

New creates a new eventid.T. This is actually more wordy than simply creating a &T{} via slice literal.

func NewFromBytes

func NewFromBytes(b []byte) (ei *T, err error)

func NewFromString

func NewFromString(s string) (ei *T, err error)

NewFromString inspects a string and ensures it is a valid, 64 character long hexadecimal string, returns the string coerced to the type.

func NewWith

func NewWith[V string | []byte](s V) (ei *T)

NewWith creates an eventid.T out of bytes or string but assumes it is binary and that it is the right length. The result is either truncated or padded automatically by the use of the "copy" operation.

func (*T) ByteString

func (ei *T) ByteString(src []byte) (b []byte)

func (*T) Bytes

func (ei *T) Bytes() (b []byte)

func (*T) Equal

func (ei *T) Equal(ei2 *T) (eq bool)

func (*T) Len

func (ei *T) Len() int

func (*T) Marshal

func (ei *T) Marshal(dst []byte) (b []byte)

func (*T) Set

func (ei *T) Set(b []byte) (err error)

Set the value of an eventid.T with checking of the length before copying it.

func (*T) String

func (ei *T) String() string

func (*T) Unmarshal

func (ei *T) Unmarshal(b []byte) (rem []byte, err error)