commonMain.io.klogging.rendering.RenderString.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of klogging-jvm

Kotlin logging library with structured logging and coroutines support

The newest version!

/*

   Copyright 2021-2024 Michael Strasser.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       https://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

*/

package io.klogging.rendering

import io.klogging.events.LogEvent

/** Interface for rendering a [LogEvent] to a String. */
public fun interface RenderString {
    /**
     * Render a log event into a string.
     *
     * @param event log event
     * @return a string representation of the event
     */
    public operator fun invoke(event: LogEvent): String
}

/** Right-align the string into a fixed-width space. */
public fun String.rightAlign(width: Int): String =
    (" ".repeat(width) + this).let { it.substring(it.length - width) }