@stdlib/os-byte-order

Byte Order

Platform byte order.

Installation

npm install @stdlib/os-byte-order

Usage

var BYTE_ORDER = require( '@stdlib/os-byte-order' );

BYTE_ORDER

Platform byte order.

console.log( BYTE_ORDER );
// => <string>

Notes

• The following values are possible:

  • 'little-endian'
  • 'big-endian'
  • 'mixed-endian' (also known as "middle-endian")
  • 'unknown'

Examples

var BYTE_ORDER = require( '@stdlib/os-byte-order' );

if ( BYTE_ORDER === 'little-endian' ) {
    console.log( 'Least significant byte comes first...' );
} else if ( BYTE_ORDER === 'big-endian' ) {
    console.log( 'Most significant byte comes first...' );
} else {
    console.log( 'This is uncommon...' );
}

---

C APIs

Installation

npm install @stdlib/os-byte-order

Usage

#include "stdlib/os/byte_order.h"

STDLIB_OS_ORDER_LITTLE_ENDIAN

Macro for an arbitrary constant indicating little-endian order.

#if defined(STDLIB_OS_BYTE_ORDER) && STDLIB_OS_BYTE_ORDER == STDLIB_OS_ORDER_LITTLE_ENDIAN

// Do something for little-endian...

#endif

If compiled on an unrecognized/unsupported platform, the macro is not defined.

STDLIB_OS_ORDER_BIG_ENDIAN

Macro for an arbitrary constant indicating big-endian order.

#if defined(STDLIB_OS_BYTE_ORDER) && STDLIB_OS_BYTE_ORDER == STDLIB_OS_ORDER_BIG_ENDIAN

// Do something for big-endian...

#endif

If compiled on an unrecognized/unsupported platform, the macro is not defined.

STDLIB_OS_BYTE_ORDER

Macro which equals either STDLIB_OS_ORDER_LITTLE_ENDIAN or STDLIB_OS_ORDER_BIG_ENDIAN (or host defined) depending on the resolved platform byte order.

#if defined(STDLIB_OS_BYTE_ORDER)

#if STDLIB_OS_BYTE_ORDER == STDLIB_OS_ORDER_LITTLE_ENDIAN

// Do something for little-endian...

#elif STDLIB_OS_BYTE_ORDER == STDLIB_OS_ORDER_BIG_ENDIAN

// Do something for big-endian...

#endif

#endif

If compiled on an unrecognized/unsupported platform, the macro is not defined.

Examples

#include "stdlib/os/byte_order.h"
#include <stdio.h>

int main() {
#if defined(STDLIB_OS_BYTE_ORDER)
#if STDLIB_OS_BYTE_ORDER == STDLIB_OS_ORDER_LITTLE_ENDIAN
    printf( "Platform is little-endian...\n" );
#elif STDLIB_OS_BYTE_ORDER == STDLIB_OS_ORDER_BIG_ENDIAN
    printf( "Platform is big-endian...\n" );
#else
    printf( "Platform endianness is either mixed-endian or unknown...\n" )
#endif
#endif
}

---

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/os-byte-order

Usage

Usage: byte-order [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ byte-order

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.2 (2021-06-16)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.1">