src/vs/workbench/services/extensions/common/proxyIdentifier.ts
85 LOC · 83 covered · 2 uncovered · 8 ranges · 195 concepts · 4 introducers · 117 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
proxyIdentifier.ts ×5
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type { VSBuffer } from '../../../../base/common/buffer.js';
import type { CancellationToken } from '../../../../base/common/cancellation.js';
export interface IRPCProtocol {
/**
* Returns a proxy to an object addressable/named in the extension host process or in the renderer process.
*/
getProxy<T>(identifier: ProxyIdentifier<T>): Proxied<T>;
/**
* Register manually created instance.
*/
set<T, R extends T>(identifier: ProxyIdentifier<T>, instance: R): R;
/**
* Assert these identifiers are already registered via `.set`.
*/
assertRegistered(identifiers: ProxyIdentifier<unknown>[]): void;
/**
* Wait for the write buffer (if applicable) to become empty.
*/
drain(): Promise<void>;
dispose(): void;
}
export class ProxyIdentifier<T> {
public static count = 0;
_proxyIdentifierBrand: void = undefined;
public readonly sid: string;
public readonly nid: number;
constructor(sid: string) {
this.nid = (++ProxyIdentifier.count);
}
const identifiers: ProxyIdentifier<unknown>[] = [];
export function createProxyIdentifier<T>(identifier: string): ProxyIdentifier<T> {
identifiers[result.nid] = result;
return result;
}
/**
* Mapped-type that replaces all JSONable-types with their toJSON-result type
*/
export type Dto<T> = T extends { toJSON(): infer U }
? U
: T extends VSBuffer // VSBuffer is understood by rpc-logic
? T
: T extends CancellationToken // CancellationToken is understood by rpc-logic
? T
: T extends Function // functions are dropped during JSON-stringify
? never
: T extends object // recurse
? { [k in keyof T]: Dto<T[k]>; }
: T;
export type Proxied<T> = { [K in keyof T]: T[K] extends (...args: infer A) => infer R
? (...args: { [K in keyof A]: Dto<A[K]> }) => Promise<Dto<Awaited<R>>>
: never
};
export function getStringIdentifierForProxy(nid: number): string {
return identifiers[nid].sid;
}
/**
* Marks the object as containing buffers that should be serialized more efficiently.
*/
export class SerializableObjectWithBuffers<T> {
constructor(
) { }