Spec-Zone.ru › Deno 1

Deno.Buffer

устаревший

Буфер с байтами переменной длины с методами read() и write().

@устаревший

Вместо этого используйте Buffer из std/io/buffer.ts. Deno.Buffer будет удален в будущем.

class Buffer implements Reader, ReaderSync, Writer, WriterSync {
constructor(ab?: ArrayBuffer);
readonly capacity: number;
readonly length: number;
bytes(options?: {
copy?: boolean;
}
): Uint8Array;
empty(): boolean;
grow(n: number): void;
read(p: Uint8Array): Promise<number | null>;
readFrom(r: Reader): Promise<number>;
readFromSync(r: ReaderSync): number;
readSync(p: Uint8Array): number | null;
reset(): void;
truncate(n: number): void;
write(p: Uint8Array): Promise<number>;
writeSync(p: Uint8Array): number;
}

Реализует

Reader
ReaderSync
Writer
WriterSync

Конструкторы

new Buffer(ab?: ArrayBuffer)

Свойства

capacity: number

Только для чтения ёмкость базового среза байтов буфера, то есть общее выделенное пространство для данных буфера.

length: number

Только для чтения количество нечитанных байтов буфера.

Методы

bytes(options?: {
copy?: boolean;
}
): Uint8Array

Возвращает срез, содержащий нечитанную часть буфера.

Срез действителен только до следующей модификации буфера (то есть, только до следующего вызова метода, такого как read(), write(), reset(), или truncate()). Если options.copy ложно, срез ссылается на содержимое буфера как минимум до следующей модификации буфера, поэтому непосредственные изменения в срезе повлияют на результат будущих чтений.

@param options

По умолчанию { copy: true }

empty(): boolean

Возвращает, пуста ли нечитанная часть буфера.

grow(n: number): void

Увеличивает ёмкость буфера, если необходимо, гарантируя место для ещё n байтов. После .grow(n), как минимум n байтов можно записать в буфер без дополнительного выделения. Если n отрицательно, .grow() выбросит ошибку. Если буфер не может увеличиться, он выбросит ошибку.

Основано на Go Lang's Buffer.Grow.

read(p: Uint8Array): Promise<number | null>

Считывает следующие p.length байтов из буфера или до тех пор, пока буфер не будет исчерпан. Возвращает количество прочитанных байтов. Если в буфере нет данных для возврата, возвращает EOF (null).

ПРИМЕЧАНИЕ: Этот метод считывает байты синхронно; он предоставляется для совместимости с интерфейсами Reader.

readFrom(r: Reader): Promise<number>

Считывает данные из r до EOF (null) и добавляет их в буфер, увеличивая буфер по мере необходимости. Возвращает количество прочитанных байтов. Если буфер становится слишком большим, .readFrom() отклонит запрос с ошибкой.

Основано на Go Lang's Buffer.ReadFrom.

readFromSync(r: ReaderSync): number

Считывает данные из r до EOF (null) и добавляет их в буфер, увеличивая буфер по мере необходимости. Возвращает количество прочитанных байтов. Если буфер становится слишком большим, .readFromSync() выбросит ошибку.

Основано на Go Lang's Buffer.ReadFrom.

readSync(p: Uint8Array): number | null

Считывает следующие p.length байтов из буфера или до тех пор, пока буфер не будет исчерпан. Возвращает количество прочитанных байтов. Если в буфере нет данных для возврата, возвращает EOF (null).

reset(): void

Сбрасывает буфер в пустое состояние, но сохраняет базовое хранилище для использования в будущих записях. .reset() эквивалентно .truncate(0).

truncate(n: number): void

Отбрасывает все, кроме первых n нечитанных байтов из буфера, но продолжает использовать то же выделенное хранилище. Выбросит ошибку, если n отрицательное или больше, чем длина буфера.

write(p: Uint8Array): Promise<number>

ПРИМЕЧАНИЕ: Этот метод записывает байты синхронно; он предоставляется для совместимости с интерфейсом Writer.

writeSync(p: Uint8Array): number

© 2018–2022 the Deno authors
https://doc.deno.land/deno/stable/~/Deno.Buffer

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API