🔊 Update 1.0.0

src/runtime_logger.mbt

@@ -1,3 +1,4 @@
+///|
 pub(all) enum RuntimeSink {
   Console(ConsoleSink)
   JsonConsole(JsonConsoleSink)
@@ -9,33 +10,54 @@ pub(all) enum RuntimeSink {
   QueuedFile(QueuedSink[FileSink])
 }
 
+///|
 pub type RuntimeFileState = @utils.RuntimeFileState
 
-pub fn file_sink_policy_to_json(policy : FileSinkPolicy) -> @json_parser.JsonValue {
+///|
+pub fn file_sink_policy_to_json(
+  policy : FileSinkPolicy,
+) -> @json_parser.JsonValue {
   @utils.file_sink_policy_to_json(policy)
 }
 
-pub fn stringify_file_sink_policy(policy : FileSinkPolicy, pretty~ : Bool = false) -> String {
-  @utils.stringify_file_sink_policy(policy, pretty=pretty)
+///|
+pub fn stringify_file_sink_policy(
+  policy : FileSinkPolicy,
+  pretty? : Bool = false,
+) -> String {
+  @utils.stringify_file_sink_policy(policy, pretty~)
 }
 
+///|
 pub fn file_sink_state_to_json(state : FileSinkState) -> @json_parser.JsonValue {
   @utils.file_sink_state_to_json(state)
 }
 
-pub fn stringify_file_sink_state(state : FileSinkState, pretty~ : Bool = false) -> String {
-  @utils.stringify_file_sink_state(state, pretty=pretty)
+///|
+pub fn stringify_file_sink_state(
+  state : FileSinkState,
+  pretty? : Bool = false,
+) -> String {
+  @utils.stringify_file_sink_state(state, pretty~)
 }
 
-pub fn runtime_file_state_to_json(state : RuntimeFileState) -> @json_parser.JsonValue {
+///|
+pub fn runtime_file_state_to_json(
+  state : RuntimeFileState,
+) -> @json_parser.JsonValue {
   @utils.runtime_file_state_to_json(state)
 }
 
-pub fn stringify_runtime_file_state(state : RuntimeFileState, pretty~ : Bool = false) -> String {
-  @utils.stringify_runtime_file_state(state, pretty=pretty)
+///|
+pub fn stringify_runtime_file_state(
+  state : RuntimeFileState,
+  pretty? : Bool = false,
+) -> String {
+  @utils.stringify_runtime_file_state(state, pretty~)
 }
 
-pub impl Sink for RuntimeSink with write(self, rec) {
+///|
+pub impl Sink for RuntimeSink with fn write(self, rec) {
   match self {
     Console(sink) => sink.write(rec)
     JsonConsole(sink) => sink.write(rec)
@@ -48,6 +70,7 @@ pub impl Sink for RuntimeSink with write(self, rec) {
   }
 }
 
+///|
 pub fn RuntimeSink::flush(self : RuntimeSink) -> Int {
   match self {
     Console(_) => 0
@@ -61,19 +84,21 @@ pub fn RuntimeSink::flush(self : RuntimeSink) -> Int {
   }
 }
 
-pub fn RuntimeSink::drain(self : RuntimeSink, max_items~ : Int = -1) -> Int {
+///|
+pub fn RuntimeSink::drain(self : RuntimeSink, max_items? : Int = -1) -> Int {
   match self {
     Console(_) => 0
     JsonConsole(_) => 0
     TextConsole(_) => 0
     File(sink) => if sink.flush() { 1 } else { 0 }
-    QueuedConsole(sink) => sink.drain(max_items=max_items)
-    QueuedJsonConsole(sink) => sink.drain(max_items=max_items)
-    QueuedTextConsole(sink) => sink.drain(max_items=max_items)
-    QueuedFile(sink) => sink.drain(max_items=max_items)
+    QueuedConsole(sink) => sink.drain(max_items~)
+    QueuedJsonConsole(sink) => sink.drain(max_items~)
+    QueuedTextConsole(sink) => sink.drain(max_items~)
+    QueuedFile(sink) => sink.drain(max_items~)
   }
 }
 
+///|
 pub fn RuntimeSink::close(self : RuntimeSink) -> Bool {
   match self {
     Console(_) => true
@@ -87,6 +112,7 @@ pub fn RuntimeSink::close(self : RuntimeSink) -> Bool {
   }
 }
 
+///|
 pub fn RuntimeSink::pending_count(self : RuntimeSink) -> Int {
   match self {
     Console(_) => 0
@@ -100,6 +126,7 @@ pub fn RuntimeSink::pending_count(self : RuntimeSink) -> Int {
   }
 }
 
+///|
 pub fn RuntimeSink::dropped_count(self : RuntimeSink) -> Int {
   match self {
     Console(_) => 0
@@ -113,63 +140,96 @@ pub fn RuntimeSink::dropped_count(self : RuntimeSink) -> Int {
   }
 }
 
+///|
 pub type ConfiguredLogger = Logger[RuntimeSink]
 
+///|
 pub fn ConfiguredLogger::flush(self : ConfiguredLogger) -> Int {
   self.sink.flush()
 }
 
-pub fn ConfiguredLogger::drain(self : ConfiguredLogger, max_items~ : Int = -1) -> Int {
-  self.sink.drain(max_items=max_items)
+///|
+pub fn ConfiguredLogger::drain(
+  self : ConfiguredLogger,
+  max_items? : Int = -1,
+) -> Int {
+  self.sink.drain(max_items~)
 }
 
+///|
 pub fn ConfiguredLogger::close(self : ConfiguredLogger) -> Bool {
   self.sink.close()
 }
 
+///|
 pub fn ConfiguredLogger::pending_count(self : ConfiguredLogger) -> Int {
   self.sink.pending_count()
 }
 
+///|
 pub fn ConfiguredLogger::dropped_count(self : ConfiguredLogger) -> Int {
   self.sink.dropped_count()
 }
 
+///|
 fn build_runtime_sink(config : SinkConfig) -> RuntimeSink {
   match config.kind {
     SinkKind::Console => RuntimeSink::Console(console_sink())
     SinkKind::JsonConsole => RuntimeSink::JsonConsole(json_console_sink())
-    SinkKind::TextConsole => RuntimeSink::TextConsole(
-      text_console_sink(config.text_formatter.to_formatter()),
-    )
-    SinkKind::File => RuntimeSink::File(
-      file_sink(
-        config.path,
-        append=config.append,
-        auto_flush=config.auto_flush,
-        rotation=config.rotation,
-        formatter=fn(rec) {
-          format_text(rec, formatter=config.text_formatter.to_formatter())
-        },
-      ),
-    )
+    SinkKind::TextConsole =>
+      RuntimeSink::TextConsole(
+        text_console_sink(config.text_formatter.to_formatter()),
+      )
+    SinkKind::File =>
+      RuntimeSink::File(
+        file_sink(
+          config.path,
+          append=config.append,
+          auto_flush=config.auto_flush,
+          rotation=config.rotation,
+          formatter=fn(rec) {
+            format_text(rec, formatter=config.text_formatter.to_formatter())
+          },
+        ),
+      )
   }
 }
 
+///|
 fn apply_queue_config(sink : RuntimeSink, queue : QueueConfig) -> RuntimeSink {
   match sink {
-    Console(inner) => RuntimeSink::QueuedConsole(
-      queued_sink(inner, max_pending=queue.max_pending, overflow=queue.overflow),
-    )
-    JsonConsole(inner) => RuntimeSink::QueuedJsonConsole(
-      queued_sink(inner, max_pending=queue.max_pending, overflow=queue.overflow),
-    )
-    TextConsole(inner) => RuntimeSink::QueuedTextConsole(
-      queued_sink(inner, max_pending=queue.max_pending, overflow=queue.overflow),
-    )
-    File(inner) => RuntimeSink::QueuedFile(
-      queued_sink(inner, max_pending=queue.max_pending, overflow=queue.overflow),
-    )
+    Console(inner) =>
+      RuntimeSink::QueuedConsole(
+        queued_sink(
+          inner,
+          max_pending=queue.max_pending,
+          overflow=queue.overflow,
+        ),
+      )
+    JsonConsole(inner) =>
+      RuntimeSink::QueuedJsonConsole(
+        queued_sink(
+          inner,
+          max_pending=queue.max_pending,
+          overflow=queue.overflow,
+        ),
+      )
+    TextConsole(inner) =>
+      RuntimeSink::QueuedTextConsole(
+        queued_sink(
+          inner,
+          max_pending=queue.max_pending,
+          overflow=queue.overflow,
+        ),
+      )
+    File(inner) =>
+      RuntimeSink::QueuedFile(
+        queued_sink(
+          inner,
+          max_pending=queue.max_pending,
+          overflow=queue.overflow,
+        ),
+      )
     QueuedConsole(_) => sink
     QueuedJsonConsole(_) => sink
     QueuedTextConsole(_) => sink
@@ -177,16 +237,21 @@ fn apply_queue_config(sink : RuntimeSink, queue : QueueConfig) -> RuntimeSink {
   }
 }
 
+///|
 pub fn build_logger(config : LoggerConfig) -> ConfiguredLogger {
   let sink = build_runtime_sink(config.sink)
   let actual_sink = match config.queue {
     None => sink
     Some(queue) => apply_queue_config(sink, queue)
   }
-  Logger::new(actual_sink, min_level=config.min_level, target=config.target)
-    .with_timestamp(enabled=config.timestamp)
+  Logger::new(actual_sink, min_level=config.min_level, target=config.target).with_timestamp(
+    enabled=config.timestamp,
+  )
 }
 
-pub fn parse_and_build_logger(input : String) -> ConfiguredLogger raise ConfigError {
+///|
+pub fn parse_and_build_logger(
+  input : String,
+) -> ConfiguredLogger raise ConfigError {
   build_logger(parse_logger_config_text(input))
 }