digraph

README

Digraph

Lookup ViM-style digraphs.

Example use

package main

import (
    "fmt"

    "github.com/xyproto/digraph"
)

func main() {
    fmt.Printf("The symbol for My is %c\n", digraph.MustLookup("My"))
}

This outputs:

The symbol for My is µ

Full list of digraphs

General info

• License: BSD-3
• Version: 1.3.0
• Author: Alexander F. Rødseth <xyproto@archlinux.org>

Documentation

Overview

Package digraph provides functions for looking up ViM-style digraphs

Index

• func All() []string
• func Lookup(digraph string) (rune, bool)
• func LookupDescription(digraph string) (string, bool)
• func MustLookup(digraph string) rune
• func MustLookupDescription(digraph string) string
• func PrintTable()

Functions

func All

func All() []string

All returns a string slice of all available digraphs

func Lookup

func Lookup(digraph string) (rune, bool)

Lookup a digraph and return a rune. Returns false if the digraph could not be found.

func LookupDescription

func LookupDescription(digraph string) (string, bool)

LookupDescription tries to look up a digraph and return a description. Returns false if the digraph could not be found.

func MustLookup

func MustLookup(digraph string) rune

MustLookup tries to look up a digraph and return a rune, but does not return any bool or error if the digraph string is not found.

func MustLookupDescription

func MustLookupDescription(digraph string) string

MustLookupDescription tries to look up a digraph and return a description, but it edoes not return any bool or error if the digraph string is not found.

func PrintTable

func PrintTable()

PrintTable outputs a table of all available digraphs