removeBinary

Available in a dev version: 0․11․0-grpc-186

How to configure

Removes the first occurrence of the specified binary value for the given key.

Binary keys must end with the "-bin" suffix according to gRPC specification. The value is compared by reference, not by content.

Return

true if the value was found and removed, false if the value was not present

Parameters

key

the name of the binary metadata entry (case-insensitive). Must contain only digits (0-9), lowercase letters (a-z), and special characters (-, _, .). Must end with -bin.

value

the binary value to remove

Throws

if the key does not end with -bin


expect fun <T> GrpcMetadata.removeBinary(key: GrpcMetadataKey<T>, value: T): Boolean(source)

Removes the first occurrence of the specified binary value for the given typed key.

Binary keys must end with the "-bin" suffix according to gRPC specification. The value is compared using the decoded form (after decoding with the key's marshaller), which encodes values as raw bytes.

Return

true if the value was found and removed, false if the value was not present

Parameters

key

the typed metadata key. The key name must end with -bin.

value

the binary value to remove

Type Parameters

T

the type of value associated with the key

Throws

if the key name does not end with -bin or contains invalid characters

Removes the first occurrence of the specified binary value for the given key.

Binary keys must end with the "-bin" suffix according to gRPC specification. The value is compared by reference, not by content.

Return

true if the value was found and removed, false if the value was not present

Parameters

key

the name of the binary metadata entry (case-insensitive). Must contain only digits (0-9), lowercase letters (a-z), and special characters (-, _, .). Must end with -bin.

value

the binary value to remove

Throws

if the key does not end with -bin


actual fun <T> GrpcMetadata.removeBinary(key: GrpcMetadataKey<T>, value: T): Boolean(source)

Removes the first occurrence of the specified binary value for the given typed key.

Binary keys must end with the "-bin" suffix according to gRPC specification. The value is compared using the decoded form (after decoding with the key's marshaller), which encodes values as raw bytes.

Return

true if the value was found and removed, false if the value was not present

Parameters

key

the typed metadata key. The key name must end with -bin.

value

the binary value to remove

Type Parameters

T

the type of value associated with the key

Throws

if the key name does not end with -bin or contains invalid characters

Removes the first occurrence of the specified binary value for the given key.

Binary keys must end with the "-bin" suffix according to gRPC specification. The value is compared by reference, not by content.

Return

true if the value was found and removed, false if the value was not present

Parameters

key

the name of the binary metadata entry (case-insensitive). Must contain only digits (0-9), lowercase letters (a-z), and special characters (-, _, .). Must end with -bin.

value

the binary value to remove

Throws

if the key does not end with -bin


actual fun <T> GrpcMetadata.removeBinary(key: GrpcMetadataKey<T>, value: T): Boolean(source)

Removes the first occurrence of the specified binary value for the given typed key.

Binary keys must end with the "-bin" suffix according to gRPC specification. The value is compared using the decoded form (after decoding with the key's marshaller), which encodes values as raw bytes.

Return

true if the value was found and removed, false if the value was not present

Parameters

key

the typed metadata key. The key name must end with -bin.

value

the binary value to remove

Type Parameters

T

the type of value associated with the key

Throws

if the key name does not end with -bin or contains invalid characters