ot

Documentation

Index

• Constants
• Variables
• func IsDelete(op *Op) bool
• func IsInsert(op *Op) bool
• func IsRetain(op *Op) bool
• func OperationTransform(a, b *Operation) (*Operation, *Operation, error)
• type Client
• type Op
  • func (o *Op) String() string
• type Operation
  • func NewOperation() *Operation
  • func OperationUnmarshal(ops []interface{}) (*Operation, error)
  • func (t *Operation) Apply(s string) (string, error)
  • func (t *Operation) At(i int) *Op
  • func (t *Operation) Delete(n int) *Operation
  • func (t *Operation) Insert(s string) *Operation
  • func (t *Operation) LastOp() *Op
  • func (t *Operation) Marshal() []interface{}
  • func (t *Operation) Retain(n int) *Operation
• type Range
  • func (r *Range) Transform(op *Operation) *Range
• type Selection
  • func SelectionUnmarshal(data map[string]interface{}) (*Selection, error)
  • func (s *Selection) SelectionMarshal() map[string]interface{}
  • func (s *Selection) Transform(op *Operation) *Selection
• type Session
  • func NewSession(document string) *Session
  • func (s *Session) AddClient(id string)
  • func (s *Session) AddOperation(revision int, op *Operation) (*Operation, error)
  • func (s *Session) RemoveClient(id string)
  • func (s *Session) SetName(id, name string)
  • func (s *Session) SetSelection(id string, sel *Selection)
• type TextEncodingType

Constants

const (
	TextEncodingTypeUTF8 = iota
	TextEncodingTypeUTF16
)

Variables

var (
	ErrOperationBaseLenMismatch = errors.New("ot/operation: base length mismatch")
	ErrOperationTransformFailed = errors.New("ot/operation: transform failed")
	ErrOperationMarshalFailed   = errors.New("ot/operation: marshal failed")
	ErrOpeartionUnmarshalFailed = errors.New("ot/operation: unmarshal failed")
)

var (
	ErrInvalidRevision = errors.New("ot/session: invalid revision")
)

var (
	ErrSelecttionUnmarshalFailed = errors.New("ot/selection: unmarshal failed")
)

var TextEncoding = TextEncodingTypeUTF8

use utf-8 by default

Functions

func IsDelete

func IsDelete(op *Op) bool

func IsInsert

func IsInsert(op *Op) bool

func IsRetain

func IsRetain(op *Op) bool

func OperationTransform

func OperationTransform(a, b *Operation) (*Operation, *Operation, error)

Types

type Client

type Client struct {
	Name      string    `json:"name"`
	Selection Selection `json:"selection"`
}

client info

type Op

type Op struct {
	N int
	S []rune
}

func (*Op) String

func (o *Op) String() string

type Operation

type Operation struct {
	Ops       []*Op
	BaseLen   int
	TargetLen int
	Meta      interface{}
}

func NewOperation

func NewOperation() *Operation

func OperationUnmarshal

func OperationUnmarshal(ops []interface{}) (*Operation, error)

func (*Operation) Apply

func (t *Operation) Apply(s string) (string, error)

func (*Operation) At

func (t *Operation) At(i int) *Op

func (*Operation) Delete

func (t *Operation) Delete(n int) *Operation

func (*Operation) Insert

func (t *Operation) Insert(s string) *Operation

func (*Operation) LastOp

func (t *Operation) LastOp() *Op

func (*Operation) Marshal

func (t *Operation) Marshal() []interface{}

func (*Operation) Retain

func (t *Operation) Retain(n int) *Operation

type Range

type Range struct {
	Anchor int `json:"anchor"`
	Head   int `json:"head"`
}

func (*Range) Transform

func (r *Range) Transform(op *Operation) *Range

type Selection

type Selection struct {
	Ranges []Range `json:"ranges"`
}

the selection range

func SelectionUnmarshal

func SelectionUnmarshal(data map[string]interface{}) (*Selection, error)

func (*Selection) SelectionMarshal

func (s *Selection) SelectionMarshal() map[string]interface{}

func (*Selection) Transform

func (s *Selection) Transform(op *Operation) *Selection

type Session

type Session struct {
	Document   string
	Operations []*Operation
	Clients    map[string]*Client
}

func NewSession

func NewSession(document string) *Session

func (*Session) AddClient

func (s *Session) AddClient(id string)

func (*Session) AddOperation

func (s *Session) AddOperation(revision int, op *Operation) (*Operation, error)

func (*Session) RemoveClient

func (s *Session) RemoveClient(id string)

func (*Session) SetName

func (s *Session) SetName(id, name string)

func (*Session) SetSelection

func (s *Session) SetSelection(id string, sel *Selection)

type TextEncodingType

type TextEncodingType int