From 66adb8f70065a4e2c232c0ff6af5aa1dacc16887 Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Tue, 9 Apr 2024 18:59:25 +0200 Subject: [PATCH] Core - Added more docs --- source/dlog/core.d | 48 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/source/dlog/core.d b/source/dlog/core.d index 58991ca..0055b59 100644 --- a/source/dlog/core.d +++ b/source/dlog/core.d @@ -5,30 +5,68 @@ */ module dlog.core; -public class Message +import std.container.slist : SList; +import core.sync.mutex : Mutex; + +/** + * The base message type + */ +public abstract class Message { } +/** + * Defines the filtering + * interface + */ public interface Filter { + /** + * Filters the given message + * returning a verdict + * based on it + * + * Params: + * message = the message + * Returns: the verdct + */ public bool filter(Message message); } +/** + * Defines the message + * transformation interface + */ public interface Transform { + /** + * Transforms the given message + * + * Params: + * message = the message input + * Returns: the transformed + * message + */ public Message transform(Message message); } +/** + * Defines the interface + * for handling messages + */ public interface Handler { + /** + * Handles the given message + * + * Params: + * message = the message to + * handle + */ public void handle(Message message); } -import std.container.slist : SList; -// import std.range : in; -import core.sync.mutex : Mutex; - public abstract class Logger { private SList!(Transform) transforms;