commonMain.aws.smithy.kotlin.runtime.http.Headers.kt Maven / Gradle / Ivy

Go to download

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

HTTP core for Smithy clients and services generated by smithy-kotlin

The newest version!

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.smithy.kotlin.runtime.http

import aws.smithy.kotlin.runtime.collections.ValuesMap
import aws.smithy.kotlin.runtime.collections.ValuesMapBuilder
import aws.smithy.kotlin.runtime.collections.ValuesMapImpl
import aws.smithy.kotlin.runtime.collections.deepCopy
import aws.smithy.kotlin.runtime.util.CanDeepCopy

/**
 * Immutable mapping of case insensitive HTTP header names to list of [String] values.
 */
public interface Headers : ValuesMap {
    public companion object {
        public operator fun invoke(block: HeadersBuilder.() -> Unit): Headers = HeadersBuilder()
            .apply(block).build()

        /**
         * Empty [Headers] instance
         */
        public val Empty: Headers = EmptyHeaders
    }
}

private object EmptyHeaders : Headers {
    override val caseInsensitiveName: Boolean = true
    override fun getAll(name: String): List = emptyList()
    override fun names(): Set = emptySet()
    override fun entries(): Set>> = emptySet()
    override fun contains(name: String): Boolean = false
    override fun isEmpty(): Boolean = true
    override fun equals(other: Any?): Boolean = other is Headers && other.isEmpty()
}

/**
 * Build an immutable HTTP header map
 */
public class HeadersBuilder :
    ValuesMapBuilder(true, 8),
    CanDeepCopy {
    override fun toString(): String = "HeadersBuilder ${entries()} "
    override fun build(): Headers = HeadersImpl(values)

    override fun deepCopy(): HeadersBuilder {
        val originalValues = values.deepCopy()
        return HeadersBuilder().apply { values.putAll(originalValues) }
    }
}

private class HeadersImpl(
    values: Map>,
) : ValuesMapImpl(true, values),
    Headers {
    override fun toString(): String = "Headers ${entries()}"
}