common

Documentation

Index

• Constants
• type Markdown
  • func (md *Markdown) MimeType() string
  • func (md *Markdown) Text() []byte
  • func (md *Markdown) Type() schema.CellType
• type MultilineString
  • func (s MultilineString) Text() (txt []byte)
  • func (s *MultilineString) UnmarshalJSON(data []byte) error
• type Notebook
  • func (n *Notebook) Version() schema.Version
• type Raw
  • func (raw *Raw) MimeType() string
  • func (raw *Raw) Text() []byte
  • func (raw *Raw) Type() schema.CellType
• type RawCellMetadata
  • func (raw *RawCellMetadata) MimeType() string

Constants

const (
	PlainText    = "text/plain"
	MarkdownText = "text/markdown"
	Stdout       = "application/vnd.jupyter.stdout" // Custom mime-type for stream output to stdout.
	Stderr       = "application/vnd.jupyter.stderr" // Custom mime-type for stream output to stderr.
)

Types

type Markdown

type Markdown struct {
	Source MultilineString `json:"source"`
}

Markdown defines the schema for a "markdown" cell.

func (*Markdown) MimeType

func (md *Markdown) MimeType() string

func (*Markdown) Text

func (md *Markdown) Text() []byte

func (*Markdown) Type

func (md *Markdown) Type() schema.CellType

type MultilineString

type MultilineString []string

MultilineString stores multi-line text as strings or string arrays in the raw JSON. TODO(optimization): check if we can scan into [][]byte directly

func (MultilineString) Text

func (s MultilineString) Text() (txt []byte)

Text concatenates all lines in a multiline string into a single byte slice.

func (*MultilineString) UnmarshalJSON

func (s *MultilineString) UnmarshalJSON(data []byte) error

type Notebook

type Notebook struct {
	VersionMajor int             `json:"nbformat"`
	VersionMinor int             `json:"nbformat_minor"`
	Metadata     json.RawMessage `json:"metadata"` // TODO: omitempty
}

func (*Notebook) Version

func (n *Notebook) Version() schema.Version

type Raw

type Raw struct {
	Source   MultilineString `json:"source"`
	Metadata RawCellMetadata `json:"metadata"`
}

Raw defines the schema for a "raw" cell.

func (*Raw) MimeType

func (raw *Raw) MimeType() string

func (*Raw) Text

func (raw *Raw) Text() []byte

func (*Raw) Type

func (raw *Raw) Type() schema.CellType

type RawCellMetadata

type RawCellMetadata struct {
	Format      *string `json:"format"`
	RawMimeType *string `json:"raw_mimetype"`
}

RawCellMetadata may specify a target conversion format.

func (*RawCellMetadata) MimeType

func (raw *RawCellMetadata) MimeType() string

MimeType returns a more specific mime-type if one is provided and "text/plain" otherwise.