dict - ActiveState ActiveGo 1.8

Package dict

import "golang.org/x/net/dict"

Overview ▾

Package dict implements the Dictionary Server Protocol as defined in RFC 2229.

type Client

A Client represents a client connection to a dictionary server.

type Client struct {
    // contains filtered or unexported fields

func Dial

func Dial(network, addr string) (*Client, error)

Dial returns a new client connected to a dictionary server at addr on the given network.

func (*Client) Close

func (c *Client) Close() error

Close closes the connection to the dictionary server.

func (*Client) Define

func (c *Client) Define(dict, word string) ([]*Defn, error)

Define requests the definition of the given word. The argument dict names the dictionary to use, the Name field of a Dict returned by Dicts.

The special dictionary name "*" means to look in all the server's dictionaries. The special dictionary name "!" means to look in all the server's dictionaries in turn, stopping after finding the word in one of them.

func (*Client) Dicts

func (c *Client) Dicts() ([]Dict, error)

Dicts returns a list of the dictionaries available on the server.

type Defn

A Defn represents a definition.

type Defn struct {
    Dict Dict   // Dict where definition was found
    Word string // Word being defined
    Text []byte // Definition text, typically multiple lines

type Dict

A Dict represents a dictionary available on the server.

type Dict struct {
    Name string // short name of dictionary
    Desc string // long description