Package Exports
- ref-struct
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ref-struct) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ref-struct
Create "struct" instances using Buffers
This module offers a "struct" implementation on top of Node.js Buffers using the ref "type" interface.
Installation
Install with npm
:
$ npm install ref-struct
Examples
Say you wanted to emulate the timeval
struct from the stdlib:
struct timeval {
time_t tv_sec; /* seconds since Jan. 1, 1970 */
suseconds_t tv_usec; /* and microseconds */
};
var ref = require('ref')
var StructType = require('ref-struct')
// define the time types
var time_t = ref.types.long
var suseconds_t = ref.types.long
// define the "timeval" struct type
var timeval = StructType({
tv_sec: time_t,
tv_usec: suseconds_t
})
// now we can create instances of it
var tv = new timeval
// this gets very powerful when combined with `node-ffi` to invoke C functions
gettimeofday(tv.ref(), null);
License
(The MIT License)
Copyright (c) 2012 Nathan Rajlich <nathan@tootallnate.net>
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.