Juan Cruz Viotti d8e31665a0 chore: follow standardjs guidelines (#1664)
- Extend the `standard` ESLint configuration
- Remove ESLint rules that are defined in the `standard` configuration
- Get rid of semi-colons

See: https://github.com/resin-io/etcher/pull/1657
Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
2017-08-03 09:01:54 -04:00

90 lines
2.6 KiB
JavaScript

/*
* Copyright 2016 resin.io
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict'
const Bluebird = require('bluebird')
const fs = Bluebird.promisifyAll(require('fs'))
const errors = require('../shared/errors')
/**
* @summary Read a buffer from an image file descriptor
* @function
* @private
*
* @param {Number} fileDescriptor - file descriptor
* @param {Number} position - image position to start reading from
* @param {Number} count - number of bytes to read
* @fulfil {Buffer} - buffer
* @returns {Promise}
*
* @example
* fs.openAsync('path/to/image.img', 'r').then((fileDescriptor) => {
* return utils.readBufferFromImageFileDescriptor(fileDescriptor, 0, 512);
* }).then((buffer) => {
* console.log(buffer);
* });
*/
exports.readBufferFromImageFileDescriptor = (fileDescriptor, position, count) => {
const BUFFER_FILL_VALUE = 0
const BUFFER_START_POSITION = 0
const buffer = Buffer.alloc(count, BUFFER_FILL_VALUE)
return fs.readAsync(fileDescriptor, buffer, BUFFER_START_POSITION, count, position).tap((bytesRead) => {
if (bytesRead !== count) {
throw errors.createUserError({
title: 'Looks like the image is truncated',
description: `We tried to read ${count} bytes at ${position}, but got ${bytesRead} bytes instead`
})
}
}).return(buffer)
}
/**
* @summary Extract the data of a readable stream
* @function
* @public
*
* @description
* You should be careful when using this function, since you can only
* extract files that are not bigger than the available computer memory.
*
* @param {StreamReadable} stream - stream
* @fulfil {Buffer} - data
* @returns {Promise}
*
* @example
* const stream = fs.createReadStream('./foo/bar');
*
* utils.extractStream(stream).then((data) => {
* console.log(data.toString());
* });
*/
exports.extractStream = (stream) => {
return new Bluebird((resolve, reject) => {
const chunks = []
stream.on('data', (chunk) => {
chunks.push(chunk)
})
stream.on('error', reject)
stream.on('end', () => {
resolve(Buffer.concat(chunks))
})
})
}