package clipper

Import Path
	github.com/zyedidia/clipper (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	    clipboard.go
	    clipboards_other.go
	    custom.go
	    detect.go
	    file.go
	    internal.go
	    multi.go
	    pb.go
	    snarf.go
	    termux.go
	    wayland.go
	    wsl.go
	    xclip.go
	    xsel.go
Package-Level Type Names (total 14)

	/* sort by: alphabet | popularity */
	 type Clipboard (interface)

		Methods (total 3)
			( Clipboard) Init() error
				Init initializes the clipboard and returns an error if it is not
				accessible

			( Clipboard) ReadAll(reg string) ([]byte, error)
				ReadAll returns the contents of the clipboard register 'reg'

			( Clipboard) WriteAll(reg string, p []byte) error
				WriteAll writes 'p' to the clipboard register 'reg'

		Implemented By (at least 10)
			*Custom
			*File
			*Internal
			*Pb
			*Snarf
			*Termux
			*Wayland
			*Wsl
			*Xclip
			*Xsel
		As Outputs Of (at least one exported)
			func GetClipboard(clips ...Clipboard) (clip Clipboard, err error)
		As Inputs Of (at least one exported)
			func GetClipboard(clips ...Clipboard) (clip Clipboard, err error)

	 type Custom (struct)

		Fields (only one)
			Name string
		Methods (total 3)
			(*Custom) Init() error
			(*Custom) ReadAll(reg string) ([]byte, error)
			(*Custom) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Custom : Clipboard

	 type ErrInvalidReg (struct)

		Fields (only one)
			Reg string
		Methods (only one)
			(*ErrInvalidReg) Error() string
		Implements (at least one exported)
			*ErrInvalidReg : error

	 type File (struct)

		Fields (only one)
			Dir string
		Methods (total 3)
			(*File) Init() error
			(*File) ReadAll(reg string) ([]byte, error)
			(*File) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*File : Clipboard

	 type Internal (struct)

		Methods (total 3)
			(*Internal) Init() error
			(*Internal) ReadAll(reg string) ([]byte, error)
			(*Internal) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Internal : Clipboard

	 type Multi (struct)

		Fields (only one)
			Clip Clipboard
		Methods (total 4)
			(*Multi) Init()
			(*Multi) IsValid(reg string, system []byte, ncursors int) bool
			(*Multi) ReadCursor(reg string, num, ncursors int) ([]byte, error)
			(*Multi) WriteCursor(reg string, p []byte, num, ncursors int) error

	 type MultiErr ([])

		Methods (only one)
			( MultiErr) Error() string
		Implements (at least one exported)
			 MultiErr : error

	 type Pb (struct)
		pbpaste/pbcopy for macos

		Methods (total 3)
			(*Pb) Init() error
			(*Pb) ReadAll(reg string) ([]byte, error)
			(*Pb) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Pb : Clipboard

	 type Snarf (struct)
		snarf for plan9

		Methods (total 3)
			(*Snarf) Init() error
			(*Snarf) ReadAll(reg string) ([]byte, error)
			(*Snarf) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Snarf : Clipboard

	 type Termux (struct)
		termux-clipboard for Android Termux

		Methods (total 3)
			(*Termux) Init() error
			(*Termux) ReadAll(reg string) ([]byte, error)
			(*Termux) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Termux : Clipboard

	 type Wayland (struct)
		wl-paste/wl-copy for linux Wayland

		Methods (total 3)
			(*Wayland) Init() error
			(*Wayland) ReadAll(reg string) ([]byte, error)
			(*Wayland) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Wayland : Clipboard

	 type Wsl (struct)
		powershell.exe/clip.exe for WSL

		Methods (total 3)
			(*Wsl) Init() error
			(*Wsl) ReadAll(reg string) ([]byte, error)
			(*Wsl) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Wsl : Clipboard

	 type Xclip (struct)
		xclip for linux X

		Methods (total 3)
			(*Xclip) Init() error
			(*Xclip) ReadAll(reg string) ([]byte, error)
			(*Xclip) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Xclip : Clipboard

	 type Xsel (struct)
		xsel for linux X

		Methods (total 3)
			(*Xsel) Init() error
			(*Xsel) ReadAll(reg string) ([]byte, error)
			(*Xsel) WriteAll(reg string, p []byte) error
		Implements (at least one exported)
			*Xsel : Clipboard


Package-Level Functions (only one)

	 func GetClipboard(clips ...Clipboard) (clip Clipboard, err error)
		GetClipboard iterates through the given clipboards and returns the first one that works.


Package-Level Variables (only one)

	  var Clipboards []Clipboard
Package-Level Constants (total 2)

	const RegClipboard = "clipboard"
	const RegPrimary = "primary"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.