clipboard

Documentation

Index

• func Clear() error
• func IsNoData(err error) bool
• func Read(formats ...string) (f int, b []byte, err error)
• func Write(formats []Format) (err error)
• type Format
• type NoDataError
  • func (err NoDataError) Error() string
  • func (err NoDataError) NotImplemented() bool

Functions

func Clear

func Clear() error

Clear removes all data from the clipboard.

func IsNoData

func IsNoData(err error) bool

IsNoData returns whether an error indicates that no data was found.

func Read

func Read(formats ...string) (f int, b []byte, err error)

Read gets data from the clipboard. If multiple clipboard formats are supported, Read selects the first format that matches one of the given media types.

Each argument is a media type (e.g. "text/plain").

If an error is returned, then f will be less than 0. If no data was found, then the error will contain NoDataError. If no formats were given, then f will be less than 0, and err will be nil.

func Write

func Write(formats []Format) (err error)

Write sets data to the clipboard. If multiple formats are supported, then each given format is written according to the specified media type. Otherwise, which format is selected is implementation-defined.

If no formats are given, then the clipboard is cleared with no other action.

Types

type Format

type Format struct {
	// Name is a media type that indicates how to interpret Content.
	Name string
	// Content is the data to be set to the clipboard.
	Content []byte
}

Format associates a media type with content.

type NoDataError

type NoDataError struct {
	// contains filtered or unexported fields
}

NoData indicates that no data was found for any of a number of given formats.

func (NoDataError) Error

func (err NoDataError) Error() string

func (NoDataError) NotImplemented

func (err NoDataError) NotImplemented() bool

NotImplemented indicates that the clipboard has no data because it is not implemented for the platform.