智能缓冲器

智能缓冲器(Smart-buffer)是一种缓冲包,可以添加自动读取和写入偏移跟踪,字符串操作,数据插入等功能.

关键特性数字 :

• 代理所有缓冲写入和读取函数
• 跟踪读取和写入自动抵消
• 视需要增加内部缓冲
• 有用的字符串操作 。 (不终止字符串)
• 允许在缓冲器中的特定点插入值
• 已建入类型脚本
• 提供的定义类型
• 浏览器支持( 使用 Webpack/ Browserify)
• 全面测试

所需资源数字 :

• 此时已支持Node v4.0+. (2.0前的版本将在0.10节点工作)

V4. 0 的中断更改

• 旧建筑师模式被完全去除. 现在需要使用 SmartBuffer.from XXX () 工厂构造器.
• 已删除倒带( ) 、 跳过( ) 、 移动 To( ) 。 (见 页:1(中文(简体) )
• 内部私有属性现在前加下划线( )
• 全体 写入xxx () 给予抵消的方法 覆盖数据 而不是插入。 (见 写入 vs 插入(中文(简体) )
• 插入 XXX () 方法已添加到您想要插入特定偏移时的数据( 这取代了在提供偏移时写入的旧行为)

寻找v3docs?

3版及先前的遗留文件 这里。 。 。 .

安装中 :

yarn add smart-buffer

或者说

npm install smart-buffer

注:已公布的国家预防机制包包括已建成的Javascript图书馆. 如果您复制了此 repo并希望手动构建库:

npm run build

使用智能缓冲器

// Javascript
const SmartBuffer = require('smart-buffer').SmartBuffer;

// Typescript
import { SmartBuffer, SmartBufferOptions} from 'smart-buffer';

简单示例

构建一个使用以下协议规格的包 :

[PacketType:2][PacketLength:2][Data:XX]

要使用香草缓冲舱来构建这个包,你必须事先计算出数据有效载荷的长度。 您还需要跟踪当前缓冲器中的“ cursor” 位置, 以便您在正确的位置写下所有文件 。 有了聪明的缓冲器 你不必做这些事.

function createLoginPacket(username, password, age, country) {
    const packet = new SmartBuffer();
    packet.writeUInt16LE(0x0060); // Some packet type
    packet.writeStringNT(username);
    packet.writeStringNT(password);
    packet.writeUInt8(age);
    packet.writeStringNT(country);
    packet.insertUInt16LE(packet.length - 2, 2);

    return packet.toBuffer();
}

利用上述功能,您现在可以做到这一点:

const login = createLoginPacket("Josh", "secret123", 22, "United States");

// <Buffer 60 00 1e 00 4a 6f 73 68 00 73 65 63 72 65 74 31 32 33 00 16 55 6e 69 74 65 64 20 53 74 61 74 65 73 00>

注意到 [PacketLength:2] 数值(1e 00)被插入到第2位.

阅读上面我们创建的软件包同样容易:

const reader = SmartBuffer.fromBuffer(login);

const logininfo = {
    packetType: reader.readUInt16LE(),
    packetLength: reader.readUInt16LE(),
    username: reader.readStringNT(),
    password: reader.readStringNT(),
    age: reader.readUInt8(),
    country: reader.readStringNT()
};

/*
{
    packetType: 96, (0x0060)
    packetLength: 30,
    username: 'Josh',
    password: 'secret123',
    age: 22,
    country: 'United States'
}
*/

写入 vs 插入

在之前的SmartBuffer版本中,.write XXX(值,平分)调用在提供抵消时会插入数据. 在第四版中,这将覆盖相抵位置的数据。 要插入数据,现在有对应的XXX(价值,相抵)方法.

智能缓冲 v3数字 :

const buff = SmartBuffer.fromBuffer(new Buffer([1,2,3,4,5,6]));
buff.writeInt8(7, 2);
console.log(buff.toBuffer())

// <Buffer 01 02 07 03 04 05 06>

智能缓冲 v4数字 :

const buff = SmartBuffer.fromBuffer(new Buffer([1,2,3,4,5,6]));
buff.writeInt8(7, 2);
console.log(buff.toBuffer());

// <Buffer 01 02 07 04 05 06>

插入时应当使用:

const buff = SmartBuffer.fromBuffer(new Buffer([1,2,3,4,5,6]));
buff.insertInt8(7, 2);
console.log(buff.toBuffer());

// <Buffer 01 02 07 03 04 05 06>

说明: 插入/写入当前所跟踪的内部缓冲器以外的位置, 您的偏移会为零 .

构建智能缓冲器

有几种不同的构建智能缓冲实例的方法.

// Creating SmartBuffer from existing Buffer
const buff = SmartBuffer.fromBuffer(buffer); // Creates instance from buffer. (Uses default utf8 encoding)
const buff = SmartBuffer.fromBuffer(buffer, 'ascii'); // Creates instance from buffer with ascii encoding for strings.

// Creating SmartBuffer with specified internal Buffer size. (Note: this is not a hard cap, the internal buffer will grow as needed).
const buff = SmartBuffer.fromSize(1024); // Creates instance with internal Buffer size of 1024.
const buff = SmartBuffer.fromSize(1024, 'utf8'); // Creates instance with internal Buffer size of 1024, and utf8 encoding for strings.

// Creating SmartBuffer with options object. This one specifies size and encoding.
const buff = SmartBuffer.fromOptions({
    size: 1024,
    encoding: 'ascii'
});

// Creating SmartBuffer with options object. This one specified an existing Buffer.
const buff = SmartBuffer.fromOptions({
    buff: buffer
});

// Creating SmartBuffer from a string.
const buff = SmartBuffer.fromBuffer(Buffer.from('some string', 'utf8'));

// Just want a regular SmartBuffer with all default options?
const buff = new SmartBuffer();

Api 参考 :

说明: SmartBuffer被完整地记录了 Typescript 定义以及 jsdocs , 所以您最喜欢的编辑器/ IDE 将具有智能感 .

目录

1. 构造
2. 数字
   1. 整数
   2. 浮点
3. 字符串
   1. 字符串
   2. 无效终止字符串
4. 缓冲
5. 减值
6. 其它

构造

构造器( )

构造器([选项])

• options {SmartBuffer 选项} 用于构建智能缓冲器的可选选项对象 .

实例:

const buff = new SmartBuffer();
const buff = new SmartBuffer({
    size: 1024,
    encoding: 'ascii'
});

类方法: 从 Buffer( 缓冲[, 编码] )

• buffer { 缓冲实例来包装.
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的字符串编码 . Default: 'utf8'

实例:

const someBuffer = Buffer.from('some string');
const buff = SmartBuffer.fromBuffer(someBuffer); // Defaults to utf8
const buff = SmartBuffer.fromBuffer(someBuffer, 'ascii');

类方法: 从Size(大小[,编码])

• size {数目} 将内部缓冲器初始化的大小.
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的字符串编码 . Default: 'utf8'

实例:

const buff = SmartBuffer.fromSize(1024); // Defaults to utf8
const buff = SmartBuffer.fromSize(1024, 'ascii');

类方法: 从选项( 选项)

• options {SmartBuffer 选项} 缓冲实例来包装.

interface SmartBufferOptions {
    encoding?: BufferEncoding; // Defaults to utf8
    size?: number; // Defaults to 4096
    buff?: Buffer;
}

实例:

const buff = SmartBuffer.fromOptions({
    size: 1024
};
const buff = SmartBuffer.fromOptions({
    size: 1024,
    encoding: 'utf8'
});
const buff = SmartBuffer.fromOptions({
    encoding: 'utf8'
});

const someBuff = Buffer.from('some string', 'utf8');
const buff = SmartBuffer.fromOptions({
    buffer: someBuff,
    encoding: 'utf8'
});

整数

buff.readInt8([抵销])

buff.readUInt8([抵销])

• offset {数目} 可选位置开始读取数据 . 默认数字 : Auto managed offset
• 回返 {数目}

读取一个 Int8 值 .

buff.readInt16BE([抵销])

buff.readInt16LE([被抵消])

buff.readUInt16BE([抵销])

buff.readUInt16LE([抵销])

• offset {数目} 可选位置开始读取数据 . 默认数字 : Auto managed offset
• 回返 {数目}

读取十六位整数值.

buff.readInt32BE([抵销])

buff.readInt32LE([抵销])

buff.readUInt32BE([抵销])

buff.readUInt32LE([抵销])

• offset {数目} 可选位置开始读取数据 . 默认数字 : Auto managed offset
• 回返 {数目}

读取32位整数值 .

buff.write Int8(值[,平分])

buff.writeUInt8(值[,平分])

• value {数目} 写作的价值.
• offset {数目} 写入此值的可选偏移 . 默认 : Auto managed offset
• 回返 这个

写入一个 Int8 值 .

buff. 插入Int8(值,平分)

buff. 插入UInt8(值,平方)

• value {数目} 要插入的值 .
• offset {数目} 页:1.
• 回返 这个

插入一个 Int8 值.

buff.write Int16BE( 数值 [,平分])

buff.write Int16LE(值[,平分])

buff.writeUInt16BE(值[,平分])

buff.writeUInt16LE(值[,平分])

• value {数目} 写作的价值.
• offset {数目} 写入此值的可选偏移 . 默认 : Auto managed offset
• 回返 这个

写入十六位整数值 .

buff. 插入 Int16BE( 值, 平分)

buff. 插入Int16LE(值,平分)

buff. 插入UInt16BE(值,平分)

buff. 插入UInt16LE(值,平分)

• value {数目} 要插入的值 .
• offset {数目} 页:1.
• 回返 这个

插入十六位整数值.

buff.write Int32BE( 值 [,平分])

buff.write Int32LE(数值[,平分])

buff.writeUInt32BE(值[,平分])

buff.writeUInt32LE(值[,平分])

• value {数目} 写作的价值.
• offset {数目} 写入此值的可选偏移 . 默认 : Auto managed offset
• 回返 这个

写入32位整数值 .

buff. 插入Int32BE( 数值, 平方)

buff. 插入Int32LE(值,平分)

buff. 插入UInt32BE( 数值, 平方)

buff.nsertUInt32LE(数值,平分)

• value {数目} 要插入的值 .
• offset {数目} 页:1.
• 回返 这个

插入32位整数值.

浮点数

buff.read FloatBE([offset]) (中文(简体) )

buff.read FloatLE([被抵消])

• offset {数目} 可选位置开始读取数据 . 默认数字 : Auto managed offset
• 回返 {数目}

读取浮取值 .

buff. read DoubleBE([被抵消]) 页面存档备份,存于互联网档案馆

buff.read DoubleLE([抵销])

• offset {数目} 可选位置开始读取数据 . 默认数字 : Auto managed offset
• 回返 {数目}

读取一双值.

buff.write FloatBE( 值 [,平分])

buff.write FloatLE( 值 [,平分])

• value {数目} 写作的价值.
• offset {数目} 写入此值的可选偏移 . 默认 : Auto managed offset
• 回返 这个

写出浮点数 .

buff. 插入FloatBE( 值, 偏移)

buff. 插入FloatLE( 数值, 偏移)

• value {数目} 要插入的值 .
• offset {数目} 页:1.
• 回返 这个

插入浮点值.

buff.write DoubleBE( 值 [,平分])

buff.write DoubleLE( 数值 [,平分])

• value {数目} 写作的价值.
• offset {数目} 写入此值的可选偏移 . 默认 : Auto managed offset
• 回返 这个

写出双值 .

buff. 插入 DoubleBE( 数值, 偏移)

buff. 插入 DoubleLE( 值, 平分)

• value {数目} 要插入的值 .
• offset {数目} 页:1.
• 回返 这个

插入双值.

字符串

buff.readString () (英语)

buff.readString(大小[,编码])

buff.readString(编码)

• size {数目} 要读取的字节数 . 默认 : Reads to the end of the Buffer.
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的字符串编码 . 默认 : utf8。 。 。 .

读取字符串值.

实例:

const buff = SmartBuffer.fromBuffer(Buffer.from('hello there', 'utf8'));
buff.readString(); // 'hello there'
buff.readString(2); // 'he'
buff.readString(2, 'utf8'); // 'he'
buff.readString('utf8'); // 'hello there'

buff.write String( 数值)

buff.write String( 数值 [, 平分])

buff.write String(值 [,编码])

buff.write String( 值 [, 偏移 [, 编码] ])

• value {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要写的字符串值 .
• offset {数目} 将此值写入的偏移 . 默认 : Auto managed offset
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的可选字符串编码 . 默认 : utf8

写入字符串值 .

实例:

buff.writeString('hello'); // Auto managed offset
buff.writeString('hello', 2);
buff.writeString('hello', 'utf8') // Auto managed offset
buff.writeString('hello', 2, 'utf8');

buff. 插入String( 值, 相抵 [, 编码])

• value {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要写的字符串值 .
• offset {数目} 将此值写入的偏移 .
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的可选字符串编码 . 默认 : utf8

插入字符串值.

实例:

buff.insertString('hello', 2);
buff.insertString('hello', 2, 'utf8');

无效终止字符串

bff.readStringNT () (中文(简体) )

buff.readStringNT(编码)

• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的字符串编码 . 默认 : utf8。 。 。 .

读取无效终止的字符串值 。 (一无所出即能读取至"缓冲".

实例:

const buff = SmartBuffer.fromBuffer(Buffer.from('hello\0 there', 'utf8'));
buff.readStringNT(); // 'hello'

// If we called this again:
buff.readStringNT(); // ' there'

buff.write StringNT( 数值)

buff.write StringNT(值[,平分])

buff.write StringNT(值[,编码])

buff. write StringNT( 值 [, 偏移 [, 编码] ])

• value {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要写的字符串值 .
• offset {数目} 将此值写入的偏移 . 默认 : Auto managed offset
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的可选字符串编码 . 默认 : utf8

写入无效终止的字符串值 .

实例:

buff.writeStringNT('hello'); // Auto managed offset   <Buffer 68 65 6c 6c 6f 00>
buff.writeStringNT('hello', 2); // <Buffer 00 00 68 65 6c 6c 6f 00>
buff.writeStringNT('hello', 'utf8') // Auto managed offset
buff.writeStringNT('hello', 2, 'utf8');

buff. 插入 StringNT( 值, 偏移[, 编码])

• value {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要写的字符串值 .
• offset {数目} 将此值写入的偏移 .
• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要使用的可选字符串编码 . 默认 : utf8

插入无效终止的字符串值.

实例:

buff.insertStringNT('hello', 2);
buff.insertStringNT('hello', 2, 'utf8');

缓冲

buff.readBuffer( [长度] )

• length {数目} 要读入缓冲器的字节数 . 默认 : Reads to the end of the Buffer

读取指定大小的缓冲.

buff.write Buffer( 值 [,平分])

• value { 要写入的缓冲值 .
• offset {数目} 将值写入的可选偏移 . 默认 : Auto managed offset

buff. 插入缓冲器( 数值, 平分)

• value { 要写入的缓冲值 .
• offset {数目} 将值写入的偏移 .

buff. read BuffernT () (英语)

读取无效终止的缓冲器 .

buff.write BuffernT( 值 [, 平分])

• value { 要写入的缓冲值 .
• offset {数目} 将值写入的可选偏移 . 默认 : Auto managed offset

写一个无效终止的缓冲器 .

buff. 插入BuffernT( 数值, 偏移)

• value { 要写入的缓冲值 .
• offset {数目} 将值写入的偏移 .

插入已终止的缓冲 .

减值

buff.readOffset (英语)

buff.readOffset(抵消) (减法)

• offset {数目} 将新值改为平移值.
• 回返情况: The current read offset

获取或设置当前读取的偏移 .

实例:

const currentOffset = buff.readOffset; // 5

buff.readOffset = 10;

console.log(buff.readOffset) // 10

buff. writeOffset (英语)

buff.write offset( 抵销)

• offset {数目} 新写值相抵以设置 .
• 回返情况: The current write offset

获取或设置当前写入偏移 .

实例:

const currentOffset = buff.writeOffset; // 5

buff.writeOffset = 10;

console.log(buff.writeOffset) // 10

buff.en编码

buff.en编码(编码)

• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 要设置的新字符串编码 .
• 回返情况: The current string encoding

获取或设置当前字符串编码 .

实例:

const currentEncoding = buff.encoding; // 'utf8'

buff.encoding = 'ascii';

console.log(buff.encoding) // 'ascii'

其它

buff. clear () (中文(简体) )

清除并重置 SmartBuffer 实例 .

保留( )

• 回返 Remaining data left to be read

获取所剩字节数待读.

内部缓冲

• 回返情况: {

获取内部管理的缓冲器( 包含未管理的数据) .

实例:

const buff = SmartBuffer.fromSize(16);
buff.writeString('hello');
console.log(buff.InternalBuffer); // <Buffer 68 65 6c 6c 6f 00 00 00 00 00 00 00 00 00 00 00>

buff. to Buffer () (英语)

• 回返情况: {

获得一个内部管理的缓冲实例。 (仅包括管理下的数据)

实例:

const buff = SmartBuffer.fromSize(16);
buff.writeString('hello');
console.log(buff.toBuffer()); // <Buffer 68 65 6c 6c 6f>

buff.to String([编码])

• encoding {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么 转换为字符串时使用的字符串编码 . 默认 : utf8
• 回返 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你来干什么

获得智能缓冲中所有数据的字符串表示.

buff.dstroy () (英语)

摧毁 SmartBuffer 实例 .

许可证

这项工作根据以下条例获得许可: 麻省理工学院许可证。 。 。 .