Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | 10x 10x 134x 4x 4x 134x | import {
assert,
literal,
never,
object,
optional,
string,
union,
} from '@metamask/superstruct';
import { BaseError } from '../BaseError.ts';
import {
marshaledErrorSchema,
ErrorCode,
MarshaledErrorStruct,
} from '../constants.ts';
import type { ErrorOptionsWithStack, MarshaledOcapError } from '../types.ts';
type StreamReadErrorData = { vatId: string } | { kernelId: string };
type StreamReadErrorOptions = Required<ErrorOptions> &
Pick<ErrorOptionsWithStack, 'stack'>;
/**
* Error indicating an unexpected failure while reading from a stream.
*/
export class StreamReadError extends BaseError {
/**
* Creates a new StreamReadError.
*
* @param data - Context data identifying the source of the error (vatId or kernelId).
* @param options - Error options including the underlying cause, stack, and data.
* @param options.data - Additional data about the error.
* @param options.data.vatId - The ID of the vat that caused the error.
* @param options.data.kernelId - The ID of the kernel that caused the error.
* @param options.cause - The underlying error that caused the stream read error.
* @param options.stack - The stack trace of the error.
*/
constructor(data: StreamReadErrorData, options: StreamReadErrorOptions) {
super(ErrorCode.StreamReadError, 'Unexpected stream read error.', {
...options,
data,
});
harden(this);
}
/**
* A superstruct struct for validating marshaled {@link StreamReadError} instances.
*/
public static struct = object({
...marshaledErrorSchema,
code: literal(ErrorCode.StreamReadError),
data: union([
object({
vatId: string(),
kernelId: optional(never()),
}),
object({
vatId: optional(never()),
kernelId: optional(never()),
}),
object({
kernelId: string(),
vatId: optional(never()),
}),
]),
cause: MarshaledErrorStruct,
});
/**
* Unmarshals a {@link MarshaledError} into a {@link StreamReadError}.
*
* @param marshaledError - The marshaled error to unmarshal.
* @param unmarshalErrorOptions - A function to unmarshal the error options.
* @returns The unmarshaled error.
*/
public static unmarshal(
marshaledError: MarshaledOcapError,
unmarshalErrorOptions: (
marshaledError: MarshaledOcapError,
) => ErrorOptionsWithStack,
): StreamReadError {
assert(marshaledError, this.struct);
return new StreamReadError(
marshaledError.data as StreamReadErrorData,
unmarshalErrorOptions(marshaledError) as StreamReadErrorOptions,
);
}
}
harden(StreamReadError);
|