Class Pot.ArrayBufferoid

Defined in: <pot.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	Pot.ArrayBufferoid(args) Pot.ArrayBufferoid is object like TypedArray that has DataView and Array prototype methods.

Field Summary
Field Attributes	Field Name and Description
	offset offset (byteOffset).
	serial A unique strings.
<static>	Pot.ArrayBufferoid.types

Method Summary
Method Attributes	Method Name and Description
<static>	Pot.ArrayBufferoid.binaryToBuffer(string) Convert to ArrayBuffer from raw string.
<static>	Pot.ArrayBufferoid.bufferToBinary(buffer) Convert to raw string from ArrayBuffer.
<static>	Pot.ArrayBufferoid.bufferToString(buffer) Convert to UTF-16 string from UTF-8 ArrayBuffer.
	concat() concat like Array.prototype.concat.
<static>	Pot.ArrayBufferoid.copyBuffer(buffer) Copt the ArrayBuffer/ArrayBufferoid/Array.
	every() every like Array.prototype.every.
	filter() filter like Array.prototype.filter.
	forEach() forEach like Array.prototype.forEach.
	getFloat32(byteOffset, (littleEndian)) Get the Float32.
	getFloat64(byteOffset, (littleEndian)) Get the Float64.
	getInt16(byteOffset, (littleEndian)) Get the Int16.
	getInt32(byteOffset, (littleEndian)) Get the Int32.
	getInt8(byteOffset) Get the Int8.
	getUint16(byteOffset, (littleEndian)) Get the Uint16.
	getUint32(byteOffset, (littleEndian)) Get the Uint32.
	getUint8(byteOffset) Get the Uint8.
	indexOf(, ) indexOf like Array.prototype.indexOf.
	isArrayBufferoid() isArrayBufferoid.
	join() join like Array.prototype.join.
	lastIndexOf(, ) lastIndexOf like Array.prototype.lastIndexOf.
	map() map like Array.prototype.map.
	pop() pop like Array.prototype.pop.
	push() push like Array.prototype.push.
	read(size) Read the buffer.
	reduce() reduce like Array.prototype.reduce.
	reverse() reverse like Array.prototype.reverse.
	seek(offset) Seek offset.
	shift() shift like Array.prototype.shift.
	size() Get the object length.
	slice(, ) slice like Array.prototype.slice.
	some() some like Array.prototype.some.
	sort() sort like Array.prototype.sort.
	splice(, , ) splice like Array.prototype.splice.
<static>	Pot.ArrayBufferoid.stringToBuffer(string) Convert to UTF-8 ArrayBuffer from UTF-16 string.
	tell() Get the current offset.
	toArray() Get the Array of this buffer.
	toString() toString like Array.prototype.toString.
	unshift() unshift like Array.prototype.unshift.
	write(data) Write the buffer.

Class Detail

Pot.ArrayBufferoid(args)

Pot.ArrayBufferoid is object like TypedArray that has DataView and Array prototype methods. That is able to cast to the each TypedArray. If environment not supported TypedArray, it will use native Array. Pot.ArrayBufferoid can coding that is compatible with other environments.

  var buffer = new Pot.ArrayBufferoid();
  var i = 0;
  buffer[i++] = 255;
  buffer[i++] = 254;
  buffer.push(253);
  buffer.push(252);
  // like DataView.
  Pot.debug(buffer.getUint16(0, true)); // 65279
  // length.
  Pot.debug('buffer.length = ' + buffer.size()); // 4
  // convert to typed array.
  var arrayBuffer = buffer.toArrayBuffer();
  var uint8Array = buffer.toUint8Array();
  // stream.
  buffer.seek(0);
  var data1 = buffer.read(1);
  Pot.debug(data1[0]); // 255
  Pot.debug(buffer.tell()); // 1
  var data2 = buffer.read(2);
  Pot.debug(data2); // [254, 253]
  buffer.seek(0);
  buffer.write([100, 101]);
  Pot.debug(buffer); // [100, 101, 253, 252]

  var buffer = new Pot.ArrayBufferoid([1, 2, 3, 4]);
  var uint8Array = buffer.map(function(val) {
    return val + 100;
  }).toUint8Array();
  Pot.debug(uint8Array[0]); // 101

Parameters:
{Array|TypedArray|Pot.ArrayBufferoid|Number|*} args: parameters.

Returns:: {Pot.ArrayBufferoid} A new instance of Pot.ArrayBufferoid.

Field Detail

{Number} offset

offset (byteOffset).

{String} serial

A unique strings.

<static> {Object} Pot.ArrayBufferoid.types

Method Detail

<static> {Function} Pot.ArrayBufferoid.binaryToBuffer(string)

Convert to ArrayBuffer from raw string.

  var string = 'abc123';
  var buffer = Pot.ArrayBufferoid.binaryToBuffer(string);
  Pot.debug(buffer); // [97, 98, 99, 49, 50, 51]

Parameters:
{String} string: A binary string.

Returns:: {Pot.ArrayBufferoid} A new instance of Pot.ArrayBufferoid.

<static> {Function} Pot.ArrayBufferoid.bufferToBinary(buffer)

Convert to raw string from ArrayBuffer.

  var view = new Uint8Array([0x61, 0x62, 0x63]);
  Pot.debug(Pot.ArrayBufferoid.bufferToBinary(view)); // 'abc'
  var buffer = new Pot.ArrayBufferoid([0x61, 0x62, 0x63]);
  Pot.debug(Pot.ArrayBufferoid.bufferToBinary(buffer)); // 'abc'

Parameters:
{Pot.ArrayBufferoid|ArrayBuffer|Array} buffer: An input bytes.

Returns:: {String} A binary string.

<static> {Function} Pot.ArrayBufferoid.bufferToString(buffer)

Convert to UTF-16 string from UTF-8 ArrayBuffer.

  var s = 'hogeほげ';
  var buffer = Pot.ArrayBufferoid.stringToBuffer(s);
  var string = Pot.ArrayBufferoid.bufferToString(buffer);
  Pot.debug(buffer);
  // buffer:
  //   [104, 111, 103, 101, 227, 129, 187, 227, 129, 146]
  Pot.debug(s === string); // true

Parameters:
{Pot.ArrayBufferoid|ArrayBuffer|Array} buffer: UTF-8 ArrayBuffer.

Returns:: {String} UTF-16 string.

{Pot.ArrayBufferoid} concat()

concat like Array.prototype.concat.

Parameters:
{...args}

Returns:: {Pot.ArrayBufferoid}

<static> {Function} Pot.ArrayBufferoid.copyBuffer(buffer)

Copt the ArrayBuffer/ArrayBufferoid/Array.

  var buffer = new ArrayBuffer(10);
  var view1 = new Uint8Array(buffer);
  var view2 = new Uint8Array(buffer);
  view1[0] = 10;
  view2[1] = 20;
  Pot.debug(view1[0]); // 10
  Pot.debug(view2[0]); // 10
  Pot.debug(view1[1]); // 20
  Pot.debug(view2[1]); // 20
  var copy = new Uint8Array(Pot.ArrayBufferoid.copyBuffer(buffer));
  copy[1] = 100;
  Pot.debug(copy[0]);  // 10
  Pot.debug(copy[1]);  // 100
  Pot.debug(view1[0]); // 10
  Pot.debug(view1[1]); // 20
  Pot.debug(view2[0]); // 10
  Pot.debug(view2[1]); // 20

Parameters:
{TypedArray|Pot.ArrayBufferoid|Array} buffer: Target array.

Returns:: {TypedArray|Pot.ArrayBufferoid|Array} Copy.

{Boolean} every()

every like Array.prototype.every.

Parameters:
{Function}

Returns:: {Boolean}

{Pot.ArrayBufferoid} filter()

filter like Array.prototype.filter.

Parameters:
{Function}

Returns:: {Pot.ArrayBufferoid}

{*} forEach()

forEach like Array.prototype.forEach.

Parameters:
{Function}

Returns:: {*}

{Function} getFloat32(byteOffset, (littleEndian))

Get the Float32.

float getFloat32(unsigned long byteOffset,
                 optional boolean littleEndian);

Parameters:
{Number} byteOffset
{(Boolean)} (littleEndian)

Returns:: {Number} float.

{Function} getFloat64(byteOffset, (littleEndian))

Get the Float64.

double getFloat64(unsigned long byteOffset,
                  optional boolean littleEndian);

Parameters:
{Number} byteOffset
{(Boolean)} (littleEndian)

Returns:: {Number} double.

{Function} getInt16(byteOffset, (littleEndian))

Get the Int16.

short getInt16(unsigned long byteOffset,
               optional boolean littleEndian);

Parameters:
{Number} byteOffset
{(Boolean)} (littleEndian)

Returns:: {Number} short.

{Function} getInt32(byteOffset, (littleEndian))

Get the Int32.

long getInt32(unsigned long byteOffset,
              optional boolean littleEndian);

Parameters:
{Number} byteOffset
{(Boolean)} (littleEndian)

Returns:: {Number} long.

{Function} getInt8(byteOffset)

Get the Int8.

byte getInt8(unsigned long byteOffset);

Parameters:
{Number} byteOffset

Returns:: {Number} byte.

{Function} getUint16(byteOffset, (littleEndian))

Get the Uint16.

unsigned short getUint16(unsigned long byteOffset,
                         optional boolean littleEndian);

Parameters:
{Number} byteOffset
{(Boolean)} (littleEndian)

Returns:: {Number} unsigned short.

{Function} getUint32(byteOffset, (littleEndian))

Get the Uint32.

unsigned long getUint32(unsigned long byteOffset,
                        optional boolean littleEndian);

Parameters:
{Number} byteOffset
{(Boolean)} (littleEndian)

Returns:: {Number} unsigned long.

{Function} getUint8(byteOffset)

Get the Uint8.

octet getUint8(unsigned long byteOffset);

Parameters:
{Number} byteOffset

Returns:: {Number} octet.

{Number} indexOf(, )

indexOf like Array.prototype.indexOf.

Parameters:
{*}
{(Number)}

Returns:: {Number}

{Function} isArrayBufferoid()

isArrayBufferoid.

{String} join()

join like Array.prototype.join.

Parameters:
{String}

Returns:: {String}

{Number} lastIndexOf(, )

lastIndexOf like Array.prototype.lastIndexOf.

Parameters:
{*}
{(Number)}

Returns:: {Number}

{Pot.ArrayBufferoid} map()

map like Array.prototype.map.

Parameters:
{Function}

Returns:: {Pot.ArrayBufferoid}

{*} pop()

pop like Array.prototype.pop.

Returns:: {*}

{Number} push()

push like Array.prototype.push.

Parameters:
{...args}

Returns:: {Number}

{Function} read(size)

Read the buffer.

Parameters:
{Number} size: Reading length.

Returns:: {Pot.ArrayBufferoid} A new instance of Pot.ArrayBufferoid.

{*} reduce()

reduce like Array.prototype.reduce.

Parameters:
{Function}

Returns:: {*}

{Pot.ArrayBufferoid} reverse()

reverse like Array.prototype.reverse.

Returns:: {Pot.ArrayBufferoid}

{Function} seek(offset)

Seek offset.

Parameters:
{Number} offset: Seek offset.

Returns:: {Number} Current offset.

{*} shift()

shift like Array.prototype.shift.

Returns:: {*}

{Function} size()

Get the object length.

Returns:: {Number} Max length of object.

{Pot.ArrayBufferoid} slice(, )

slice like Array.prototype.slice.

Parameters:
{Number}
{(Number)}

Returns:: {Pot.ArrayBufferoid}

{Boolean} some()

some like Array.prototype.some.

Parameters:
{Function}

Returns:: {Boolean}

{Pot.ArrayBufferoid} sort()

sort like Array.prototype.sort.

Parameters:
{(Function)}

Returns:: {Pot.ArrayBufferoid}

{*} splice(, , )

splice like Array.prototype.splice.

Parameters:
{Number}
{Number}
{...args}

Returns:: {*}

<static> {Function} Pot.ArrayBufferoid.stringToBuffer(string)

Convert to UTF-8 ArrayBuffer from UTF-16 string.

  var s = 'hogeほげ';
  var buffer = Pot.ArrayBufferoid.stringToBuffer(s);
  var string = Pot.ArrayBufferoid.bufferToString(buffer);
  Pot.debug(buffer);
  // buffer:
  //   [104, 111, 103, 101, 227, 129, 187, 227, 129, 146]
  Pot.debug(s === string); // true

Parameters:
{String} string: UTF-16 string.

Returns:: {Pot.ArrayBufferoid} A new instance of Pot.ArrayBufferoid that UTF-8 ArrayBuffer.

{Function} tell()

Get the current offset.

Returns:: {Number} Current offset.

{Function} toArray()

Get the Array of this buffer.

Returns:: {Array} Array of this buffer.

{String} toString()

toString like Array.prototype.toString.

Returns:: {String}

{Number} unshift()

unshift like Array.prototype.unshift.

Returns:: {Number}

{Function} write(data)

Write the buffer.

Parameters:
{Array|*} data: Data to write.

Returns:: {Number} Written length.

Classes

Class Pot.ArrayBufferoid