BencodeString Class

public sealed class BencodeString : BencodeValue, IEquatable<BencodeString>

No documentation is available.

Inheritance
BencodeValue BencodeString
Implements

Constructors

NameDescription
BencodeString(ReadOnlyMemory<byte>)

BencodeString(ReadOnlyMemory<byte>)

BencodeString.cs
public BencodeString(ReadOnlyMemory<byte> value)

Parameters

value ReadOnlyMemory<byte>

No documentation is available.

Properties

NameDescription
Kind
Value
public override BencodeValueKind Kind { get; }

Property value

BencodeValueKind

No documentation is available.

public ReadOnlyMemory<byte> Value { get; }

Property value

ReadOnlyMemory<byte>

No documentation is available.

Methods

NameDescription
Equals(BencodeString?)
Equals(object?)
GetHashCode()
ToString()Returns a representation suitable for diagnostics. Bencode strings hold arbitrary bytes, so a value that is not valid UTF-8 is rendered as hexadecimal instead.
ToUtf8String()Decodes the value as UTF-8.
WriteTo(BencodeWriter, bool)

Equals overloads

Equals(BencodeString?)

BencodeString.cs
public bool Equals(BencodeString? other)
Parameters
other BencodeString?
Returns

bool

No documentation is available.

Equals(object?)

BencodeString.cs
public override bool Equals(object? obj)
Parameters
obj object?
Returns

bool

No documentation is available.

GetHashCode()

BencodeString.cs
public override int GetHashCode()

Returns

int

No documentation is available.

Returns a representation suitable for diagnostics. Bencode strings hold arbitrary bytes, so a value that is not valid UTF-8 is rendered as hexadecimal instead.

public override string ToString()

Returns

string

ToUtf8String()

BencodeString.cs

Decodes the value as UTF-8.

public string ToUtf8String()

Returns

string

Exceptions

DecoderFallbackException
The value is not valid UTF-8. Bencode strings hold arbitrary bytes, so use BencodeString.ToString when the value may be binary.

WriteTo(BencodeWriter, bool)

BencodeString.cs
public override void WriteTo(BencodeWriter writer, bool canonical)

Parameters

writer BencodeWriter
canonical bool

No documentation is available.