maddy

 1/*
 2Maddy Mail Server - Composable all-in-one email server.
 3Copyright © 2019-2020 Max Mazurov <fox.cpp@disroot.org>, Maddy Mail Server contributors
 4
 5This program is free software: you can redistribute it and/or modify
 6it under the terms of the GNU General Public License as published by
 7the Free Software Foundation, either version 3 of the License, or
 8(at your option) any later version.
 9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program.  If not, see <https://www.gnu.org/licenses/>.
17*/
18
19package module
20
21import "context"
22
23// Table is the interface implemented by module that implementation string-to-string
24// translation.
25//
26// Modules implementing this interface should be registered with prefix
27// "table." in name.
28type Table interface {
29	Lookup(ctx context.Context, s string) (string, bool, error)
30}
31
32// MultiTable is the interface that module can implement in addition to Table
33// if it can provide multiple values as a lookup result.
34type MultiTable interface {
35	LookupMulti(ctx context.Context, s string) ([]string, error)
36}
37
38type MutableTable interface {
39	Table
40	Keys() ([]string, error)
41	RemoveKey(k string) error
42	SetKey(k, v string) error
43}