conf

README

conf

conf est une librairie Go pour gérer des fichiers de configuration .conf

Documentation

Index

• type Configuration
  • func New(template string) *Configuration
  • func (c *Configuration) Get(key string) string
  • func (c *Configuration) GetBool(key string) (out bool)
  • func (c *Configuration) GetInt(key string) (out int)
  • func (c *Configuration) GetSlice(key string) (out []string)
  • func (c *Configuration) Keys() []string
  • func (c *Configuration) Position(key string) int
  • func (c *Configuration) Read(r io.Reader)
  • func (c *Configuration) Set(key string, value any) (ok bool)
  • func (c *Configuration) Write(w io.Writer) error
• type ConfigurationFile
  • func NewFile(template, filepath string) *ConfigurationFile
  • func (cf *ConfigurationFile) Load() error
  • func (cf *ConfigurationFile) Save() error

Types

type Configuration

type Configuration struct {
	// contains filtered or unexported fields
}

Configuration représente le contenu d’un fichier de configuration de la forme .ini. Un fichier .ini a la forme suivante :

[section1]
clé1 = valeur
clé2 = valeur
; un commentaire éventuel
#un autre commentaire
[section2]
clé1 = valeur
<...>

L’accès aux clés de la configuration se fait en préfixant la clé souhaitée par la section d’appartenance suivie d’un point (exemple : section1.clé1).

Les types de valeurs supportées actuellement sont : - les chaînes de caractère - les booléens : 0, 1, true, false - les entiers - les tableaux de chaînes : ce sont des chaînes séparées par des virgules

La conversion entre ces différents types se fait sans panic et aucun contrôle n’est effectué sur la cohérence des données.

func New

func New(template string) *Configuration

New crée une nouvelle configuration à partir d’un template. Le template doit avoir la structure d’un fichier .ini.

func (*Configuration) Get

func (c *Configuration) Get(key string) string

Get retourne la valeur de la clé demandée. Si celle-ci n’existe pas, une chaîne vide est retournée.

func (*Configuration) GetBool

func (c *Configuration) GetBool(key string) (out bool)

GetBool retourne la valeur de la clé demandée, convertie en booléen.

func (*Configuration) GetInt

func (c *Configuration) GetInt(key string) (out int)

GetBool retourne la valeur de la clé demandée, convertie en entier.

func (*Configuration) GetSlice

func (c *Configuration) GetSlice(key string) (out []string)

GetBool retourne la valeur de la clé demandée, convertie en slice.

func (*Configuration) Keys

func (c *Configuration) Keys() []string

Keys retourne la liste des clés de la configuration. Chaque clé est des la forme section.clé.

func (*Configuration) Position

func (c *Configuration) Position(key string) int

Position retourne le numéro de ligne dans laquelle se trouve la clé donnée. Les n° de ligne commencent à partir de 0. Si la clé n’est pas trouvé, -1 est retourné.

func (*Configuration) Read

func (c *Configuration) Read(r io.Reader)

Read parse la configuration du descripteur d’entrée.

func (*Configuration) Set

func (c *Configuration) Set(key string, value any) (ok bool)

Set définit la clé key à la valeur value. Si la clé n’existe pas, aucune modification n’est effectuée et la méthode retourne false.

func (*Configuration) Write

func (c *Configuration) Write(w io.Writer) error

Write écrit la configuration dans le descripteur de sortie.

type ConfigurationFile

type ConfigurationFile struct {
	*Configuration
	Path string
}

ConfigurationFile représente un fichier de configuration.

func NewFile

func NewFile(template, filepath string) *ConfigurationFile

NewFile génère un nouveau fichier de de configuration. Rien n’est inscrit sur le chemin donnée et cela reste en mémoire tant que la méthode Save n’est pas appelée explicitement. Par ailleurs, le fichier dans le filepath n’est pas parsé tant que la méthode Load n’est pas appelée explicitement.

func (*ConfigurationFile) Load

func (cf *ConfigurationFile) Load() error

Load charge la configuration

func (*ConfigurationFile) Save

func (cf *ConfigurationFile) Save() error

Save enregistre la configuration sur le disque.