maConf

Documentation

Overview

Package maConf reads and writes the configurations.

Index

• Constants
• func PopulateConfig(file string) error
• type Config
  • func ReadConfig(path string) (*Config, error)
  • func (conf *Config) UpdateCredentials(userID string, accessToken string, homeServer string) error
• type Login
• type Preferences

Constants

const (
	// VERSION contains the mahou version.
	VERSION = "0.0.1"
	// PATH contains relative or absolute default path to the configuration
	// file.
	PATH = "mahou.conf"
)

Functions

func PopulateConfig

func PopulateConfig(file string) error

PopulateConfig copies the sample config to <path>.

Types

type Config

type Config struct {
	Login *Login
	Prefs *Preferences
	// contains filtered or unexported fields
}

Config represents the whole mahou configuration, containing all the needed substructures.

func ReadConfig

func ReadConfig(path string) (*Config, error)

ReadConfig reads the configuration file.

func (*Config) UpdateCredentials

func (conf *Config) UpdateCredentials(userID string, accessToken string,
	homeServer string) error

UpdateCredentials writes access token to the config and redacts localpart and password.

type Login

type Login struct {
	Localpart  string
	Password   string
	HomeServer string

	UserID      string
	AccessToken string
}

Login represents the information needed to log into a Matrix server.

type Preferences

type Preferences struct {
}

Preferences represents settings that are not required.