profile

Documentation

Overview

Package profile defines a qri peer profile

Index

• Variables
• type ID
  • func IDB58Decode(proid string) (ID, error)
  • func IDB58DecodeOrEmpty(proid string) ID
  • func IDB58MustDecode(proid string) ID
  • func IDFromPeerID(pid peer.ID) ID
  • func IDRawByteString(data string) ID
  • func NewB58ID(pid string) (ID, error)
  • func (id ID) MarshalJSON() ([]byte, error)
  • func (id *ID) MarshalYAML() (interface{}, error)
  • func (id ID) String() string
  • func (id *ID) UnmarshalJSON(data []byte) (err error)
  • func (id *ID) UnmarshalYAML(unmarshal func(interface{}) error) (err error)
• type MemStore
  • func (m *MemStore) DeleteProfile(id ID) error
  • func (m *MemStore) GetProfile(id ID) (*Profile, error)
  • func (m *MemStore) List() (map[ID]*Profile, error)
  • func (m *MemStore) PeerIDs(id ID) ([]peer.ID, error)
  • func (m *MemStore) PeerProfile(id peer.ID) (*Profile, error)
  • func (m *MemStore) PeernameID(peername string) (ID, error)
  • func (m *MemStore) PutProfile(profile *Profile) error
• type Profile
  • func NewProfile(p *config.ProfilePod) (pro *Profile, err error)
  • func (p *Profile) Decode(sp *config.ProfilePod) error
  • func (p Profile) Encode() (*config.ProfilePod, error)
• type Store
  • func NewMemStore() Store
• type Type
  • func ParseType(t string) (Type, error)
  • func (t Type) MarshalJSON() ([]byte, error)
  • func (t Type) String() string
  • func (t *Type) UnmarshalJSON(data []byte) (err error)

Variables

var ErrNotFound = fmt.Errorf("profile: not found")

ErrNotFound is the not found err for the profile package

Types

type ID

type ID peer.ID

ID is a distinct thing form a peer.ID. They are *NOT* meant to be interchangable but the mechanics of peer.ID & profile.ID are exactly the same

func IDB58Decode

func IDB58Decode(proid string) (ID, error)

IDB58Decode proxies a lower level API b/c I'm lazy & don't like

func IDB58DecodeOrEmpty

func IDB58DecodeOrEmpty(proid string) ID

IDB58DecodeOrEmpty decodes an ID, or returns an empty ID if decoding fails

func IDB58MustDecode

func IDB58MustDecode(proid string) ID

IDB58MustDecode panics if an ID doesn't decode. useful for testing

func IDFromPeerID

func IDFromPeerID(pid peer.ID) ID

IDFromPeerID type casts a peer.ID from ipfs into an ID

func IDRawByteString

func IDRawByteString(data string) ID

IDRawByteString constructs an ID from a raw byte string. No decoding happens. Should only be used in tests

func NewB58ID

func NewB58ID(pid string) (ID, error)

NewB58ID creates a peer.ID from a base58-encoded string

func (ID) MarshalJSON

func (id ID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ID

func (*ID) MarshalYAML

func (id *ID) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface for ID

func (ID) String

func (id ID) String() string

String implements the stringer interface for ID

func (*ID) UnmarshalJSON

func (id *ID) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface for ID

func (*ID) UnmarshalYAML

func (id *ID) UnmarshalYAML(unmarshal func(interface{}) error) (err error)

UnmarshalYAML implements the yaml.Unmarshaler interface for ID

type MemStore

type MemStore struct {
	sync.Mutex
	// contains filtered or unexported fields
}

MemStore is an in-memory implementation of the profile Store interface

func (*MemStore) DeleteProfile

func (m *MemStore) DeleteProfile(id ID) error

DeleteProfile removes a peer from this store

func (*MemStore) GetProfile

func (m *MemStore) GetProfile(id ID) (*Profile, error)

GetProfile give's peer info from the store for a given peer.ID

func (*MemStore) List

func (m *MemStore) List() (map[ID]*Profile, error)

List hands the full list of peers back

func (*MemStore) PeerIDs

func (m *MemStore) PeerIDs(id ID) ([]peer.ID, error)

PeerIDs gives the peer.IDs list for a given peername

func (*MemStore) PeerProfile

func (m *MemStore) PeerProfile(id peer.ID) (*Profile, error)

PeerProfile returns profile data for a given peer.ID TODO - this func implies that peer.ID's are only ever connected to the same profile. That could cause trouble.

func (*MemStore) PeernameID

func (m *MemStore) PeernameID(peername string) (ID, error)

PeernameID gives the ID for a given peername

func (*MemStore) PutProfile

func (m *MemStore) PutProfile(profile *Profile) error

PutProfile adds a peer to this store

type Profile

type Profile struct {
	ID ID `json:"id"`
	// Created timestamp
	Created time.Time `json:"created,omitempty"`
	// Updated timestamp
	Updated time.Time `json:"updated,omitempty"`
	// PrivKey is the peer's private key, should only be present for the current peer
	PrivKey crypto.PrivKey `json:"_,omitempty"`
	// Peername a handle for the user. min 1 character, max 80. composed of [_,-,a-z,A-Z,1-9]
	Peername string `json:"peername"`
	// specifies weather this is a user or an organization
	Type Type `json:"type"`
	// user's email address
	Email string `json:"email"`
	// user name field. could be first[space]last, but not strictly enforced
	Name string `json:"name"`
	// user-filled description of self
	Description string `json:"description"`
	// url this user wants the world to click
	HomeURL string `json:"homeUrl"`
	// color this user likes to use as their theme color
	Color string `json:"color"`
	// Thumb path for user's thumbnail
	Thumb string `json:"thumb"`
	// Profile photo
	Photo string `json:"photo"`
	// Poster photo for users's profile page
	Poster string `json:"poster"`
	// Twitter is a  peer's twitter handle
	Twitter string `json:"twitter"`
	// Online indicates if this peer is currently connected to the network
	Online bool `json:"online,omitempty"`
	// PeerIDs lists any network PeerIDs associated with this profile
	// in the form /network/peerID
	PeerIDs []peer.ID `json:"peerIDs"`
	// NetworkAddrs keeps a list of locations for this profile on the network as multiaddr strings
	NetworkAddrs []ma.Multiaddr `json:"networkAddrs,omitempty"`
}

Profile defines peer profile details

func NewProfile

func NewProfile(p *config.ProfilePod) (pro *Profile, err error)

NewProfile allocates a profile from a CodingProfile

func (*Profile) Decode

func (p *Profile) Decode(sp *config.ProfilePod) error

Decode turns a ProfilePod into a profile.Profile

func (Profile) Encode

func (p Profile) Encode() (*config.ProfilePod, error)

Encode returns a ProfilePod for a given profile

type Store

type Store interface {
	List() (map[ID]*Profile, error)
	PeerIDs(id ID) ([]peer.ID, error)
	PeernameID(peername string) (ID, error)
	PutProfile(profile *Profile) error
	GetProfile(id ID) (*Profile, error)
	PeerProfile(id peer.ID) (*Profile, error)
	DeleteProfile(id ID) error
}

Store is a store of profile information

func NewMemStore

func NewMemStore() Store

NewMemStore allocates a MemStore

type Type

type Type int

Type enumerates different types of peers

const (
	// TypePeer is a single person
	TypePeer Type = iota
	// TypeOrganization represents a group of people
	TypeOrganization
)

func ParseType

func ParseType(t string) (Type, error)

ParseType decodes a peer type from a string

func (Type) MarshalJSON

func (t Type) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for Type

func (Type) String

func (t Type) String() string

String implements the Stringer interface for Type

func (*Type) UnmarshalJSON

func (t *Type) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface for Type