clipboard

Documentation

Overview

Package clipboard provide a simple clipboard read and write operations.

Index

• Constants
• func Available() bool
• func GetReaderBin() string
• func GetWriterBin() string
• func ReadString() (string, error)
• func Reset() error
• func WriteString(s string) error
• type Clipboard
  • func New() *Clipboard
  • func (c *Clipboard) Available() bool
  • func (c *Clipboard) Flush() error
  • func (c *Clipboard) Read() ([]byte, error)
  • func (c *Clipboard) ReadString() (string, error)
  • func (c *Clipboard) ReadToFile(filepath string) error
  • func (c *Clipboard) Reset() error
  • func (c *Clipboard) Write(p []byte) (int, error)
  • func (c *Clipboard) WriteFromFile(filepath string) error
  • func (c *Clipboard) WriteString(s string) (int, error)

Constants

const (
	WriterOnMac = "pbcopy"
	WriterOnWin = "clip" // clip only support write contents to clipboard.
	WriterOnLin = "xsel"

	ReaderOnMac = "pbpaste"
	ReaderOnWin = "powershell get-clipboard" // read should use: powershell get-clipboard
	ReaderOnLin = "xclip"
)

clipboard writer, reader program names

Functions

func Available

func Available() bool

Available clipboard available check

func GetReaderBin

func GetReaderBin() string

GetReaderBin program name

func GetWriterBin

func GetWriterBin() string

GetWriterBin program name

func ReadString

func ReadString() (string, error)

ReadString contents from clipboard

func Reset

func Reset() error

Reset clipboard data

func WriteString

func WriteString(s string) error

WriteString contents to clipboard and flush

Types

type Clipboard

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

Clipboard struct

func New

func New() *Clipboard

New instance

func (*Clipboard) Available

func (c *Clipboard) Available() bool

Available check

func (*Clipboard) Flush

func (c *Clipboard) Flush() error

Flush buffer contents to clipboard

func (*Clipboard) Read

func (c *Clipboard) Read() ([]byte, error)

Read contents from clipboard

func (*Clipboard) ReadString

func (c *Clipboard) ReadString() (string, error)

ReadString contents as string from clipboard

func (*Clipboard) ReadToFile

func (c *Clipboard) ReadToFile(filepath string) error

ReadToFile dump clipboard data to file

func (*Clipboard) Reset

func (c *Clipboard) Reset() error

Reset and clean the clipboard

func (*Clipboard) Write

func (c *Clipboard) Write(p []byte) (int, error)

Write bytes data to clipboard

func (*Clipboard) WriteFromFile

func (c *Clipboard) WriteFromFile(filepath string) error

WriteFromFile contents to clipboard

func (*Clipboard) WriteString

func (c *Clipboard) WriteString(s string) (int, error)

WriteString data to clipboard