Utf8StringTryFormat(SpanByte, Int32, ReadOnlySpanChar, IFormatProvider) Method

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 0.3.0+dc1307f20e065bb638e0b73a34cd216f57e486f1

Syntax

C++

Copy

public bool TryFormat(
	Span<byte> utf8Destination,
	out int bytesWritten,
	ReadOnlySpan<char> format,
	IFormatProvider? provider
)

Public Function TryFormat ( 
	utf8Destination As Span(Of Byte),
	<OutAttribute> ByRef bytesWritten As Integer,
	format As ReadOnlySpan(Of Char),
	provider As IFormatProvider
) As Boolean

public:
virtual bool TryFormat(
	Span<unsigned char> utf8Destination, 
	[OutAttribute] int% bytesWritten, 
	ReadOnlySpan<wchar_t> format, 
	IFormatProvider^ provider
) sealed

abstract TryFormat : 
        utf8Destination : Span<byte> * 
        bytesWritten : int byref * 
        format : ReadOnlySpan<char> * 
        provider : IFormatProvider -> bool 
override TryFormat : 
        utf8Destination : Span<byte> * 
        bytesWritten : int byref * 
        format : ReadOnlySpan<char> * 
        provider : IFormatProvider -> bool

Parameters

utf8Destination SpanByte: The span in which to write this instance's value formatted as a span of bytes.
bytesWritten Int32: When this method returns, contains the number of bytes that were written in utf8Destination.
format ReadOnlySpanChar: A span containing the characters that represent a standard or custom format string that defines the acceptable format for utf8Destination.
provider IFormatProvider: An optional object that supplies culture-specific formatting information for utf8Destination.

Return Value

Boolean
if the formatting was successful; otherwise, .

Implements

IUtf8SpanFormattable.TryFormat(SpanByte, Int32, ReadOnlySpanChar, IFormatProvider)

Reference

Utf8String Class

TryFormat Overload

Ookii.Jumbo.IO Namespace