bice

Bice

Bice, a tiny module that offers a fast way to swap arbitrary length sequences of bytes within a Buffer, using only the Buffer itself and the bitwise XOR operator.

###Install

$ npm install bice [-g]

require returns an helper hash/obj.

var Bice  = require( 'bice' );

###Run Tests

to run all test files, install devDependecies:

 $ cd bice/
 # install or update devDependecies 
 $ npm install --dev
 # run tests
 $ npm test

to execute a single test file simply do:

 $ node test/file-name.js

Methods

Arguments within [ ] are optional.

/*
 * Swap 2 sequences in a Buffer, swapping 1 byte at the time.
 * It returns true if swapping was successfull, false otherwise.
 *
 * NOTE:
 * - sequences shouldn't overlap.
 * - sequences shouldn't overflow Buffer length.
 * - sequence 1 starts from pos1 and ends to pos1 + bytes - 1.
 * - sequence 2 starts from pos2 and ends to pos2 + bytes - 1.
 * - pos1 could be > than pos2, the order of indexes doesn't matter.
 */
Bice#swap : function ( Buffer buffer, Number pos1, Number pos2 , Number bytes ) : Boolean

/*
 * Reverse an entire Buffer or a part of it, swapping 1 byte at the time.
 * It returns true if reversing was successfull, false otherwise.
 */
Bice#reverse : function ( Buffer buffer [, Number pos [, Number bytes ] ] ) : Boolean

/*
 * Compares values from 2 buffers.
 * Optionally, it accepts the number of bytes to read; if it is not specified,
 * it compares a number of bytes equals to the length of the smaller Buffer.
 *
 * It returns:
 *
 * -  0 when b1 === b2
 * - +1 when b1 > b2
 * - -1 when b1 < b2
 * - null otherwise (read index overflow, 0-length Buffers, ..)
 *
 */
Bice#compare : function ( Buffer b1, Number p1, Buffer b2, Number p2 [, Number bytes ] ) : Number

MIT License

Copyright (c) 2014 < Guglielmo Ferri : [e-mail] >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.