@azure-tools/typespec-rust 0.1.0 → 0.2.0

package/dist/src/emitter.js

@@ -7,6 +7,11 @@ import { Adapter } from './tcgcadapter/adapter.js';
 import { mkdir, writeFile } from 'fs/promises';
 import * as path from 'path';
 import 'source-map-support/register.js';
+/**
+ * entry point called by the tsp compiler
+ *
+ * @param context the emit context
+ */
 export async function $onEmit(context) {
     const adapter = await Adapter.create(context);
     const crate = adapter.tcgcToCrate();
@@ -19,27 +24,22 @@ export async function $onEmit(context) {
     // TODO: this will overwrite an existing lib.rs file.
     // we will likely need to support merging generated content with a preexisting lib.rs
     // https://github.com/Azure/typespec-rust/issues/20
-    await writeFile(`${context.emitterOutputDir}/src/lib.rs`, codegen.emitLib());
-    await writeToGeneratedDir(context.emitterOutputDir, 'mod.rs', codegen.emitMod());
-    const models = codegen.emitModels();
-    if (models.length > 0) {
-        await writeToGeneratedDir(context.emitterOutputDir, 'models.rs', models);
-    }
-    const enums = codegen.emitEnums();
-    if (enums.length > 0) {
-        await writeToGeneratedDir(context.emitterOutputDir, 'enums.rs', enums);
-    }
-    const clientFiles = codegen.emitClients();
-    for (const clientFile of clientFiles) {
-        await writeToGeneratedDir(context.emitterOutputDir, clientFile.name, clientFile.content, 'clients');
+    await writeFile(`${context.emitterOutputDir}/src/lib.rs`, codegen.emitLibRs());
+    const files = codegen.emitContent();
+    for (const file of files) {
+        await writeToGeneratedDir(context.emitterOutputDir, file.name, file.content);
     }
 }
-async function writeToGeneratedDir(outDir, filename, content, subdir) {
-    let srcGen = `${outDir}/src/generated`;
-    if (subdir) {
-        srcGen = path.join(srcGen, subdir);
-    }
-    await mkdir(srcGen, { recursive: true });
-    await writeFile(`${srcGen}/${filename}`, content);
+/**
+ *
+ * @param outDir the output directory provided by the tsp compiler
+ * @param filename the name of the file to write. can contain sub-directories
+ * @param content the contents of the file
+ */
+async function writeToGeneratedDir(outDir, filename, content) {
+    const fullFilePath = path.join(outDir, 'src', 'generated', filename);
+    const fullDirPath = fullFilePath.substring(0, fullFilePath.lastIndexOf(path.sep));
+    await mkdir(fullDirPath, { recursive: true });
+    await writeFile(fullFilePath, content);
 }
 //# sourceMappingURL=emitter.js.map

package/dist/src/emitter.js.map

@@ -1 +1 @@
-{"version":3,"file":"emitter.js","sourceRoot":"","sources":["../../src/emitter.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,gCAAgC,CAAC;AAExC,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAwC;IACpE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAEpC,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,gBAAgB,MAAM,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAEzC,oDAAoD;IACpD,4EAA4E;IAC5E,mDAAmD;IACnD,MAAM,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAEnF,qDAAqD;IACrD,qFAAqF;IACrF,mDAAmD;IACnD,MAAM,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,aAAa,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAE7E,MAAM,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjF,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IACpC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;KAC1E;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAClC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACpB,MAAM,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;KACxE;IAED,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAC1C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,MAAM,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;KACrG;AACH,CAAC;AAED,KAAK,UAAU,mBAAmB,CAAC,MAAc,EAAE,QAAgB,EAAE,OAAe,EAAE,MAAe;IACnG,IAAI,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC;IACvC,IAAI,MAAM,EAAE;QACV,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC;IACD,MAAM,KAAK,CAAC,MAAM,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IACvC,MAAM,SAAS,CAAC,GAAG,MAAM,IAAI,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC"}
+{"version":3,"file":"emitter.js","sourceRoot":"","sources":["../../src/emitter.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAwC;IACpE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAEpC,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,gBAAgB,MAAM,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAEzC,oDAAoD;IACpD,4EAA4E;IAC5E,mDAAmD;IACnD,MAAM,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAEnF,qDAAqD;IACrD,qFAAqF;IACrF,mDAAmD;IACnD,MAAM,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,aAAa,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE/E,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,mBAAmB,CAAC,MAAc,EAAE,QAAgB,EAAE,OAAe;IAClF,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrE,MAAM,WAAW,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClF,MAAM,KAAK,CAAC,WAAW,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAC5C,MAAM,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC"}

package/dist/src/lib.d.ts

@@ -1,3 +1,4 @@
+/** the public Rust emitter options */
 export interface RustEmitterOptions {
     'crate-name': string;
     'crate-version': string;

package/dist/src/lib.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CACzB;AAoBD,eAAO,MAAM,IAAI;;6BAAgC,CAAC;AAClD,eAAO,MAAQ,gBAAgB;;;;mBAAE,iBAAiB,4BAAE,SAAS,wFAAS,CAAC"}
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAOA,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CACzB;AAoBD,eAAO,MAAM,IAAI;;6BAAgC,CAAC;AAElD,eAAO,MAAQ,gBAAgB;;;;mBAAE,iBAAiB,4BAAE,SAAS,wFAAS,CAAC"}

package/dist/src/lib.js

@@ -20,5 +20,6 @@ const libDef = {
     },
 };
 export const $lib = createTypeSpecLibrary(libDef);
+/* eslint-disable-next-line @typescript-eslint/unbound-method */
 export const { reportDiagnostic, createStateSymbol, getTracer } = $lib;
 //# sourceMappingURL=lib.js.map

package/dist/src/lib.js.map

@@ -1 +1 @@
-{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,qBAAqB,EAAkB,MAAM,oBAAoB,CAAC;AAO3E,MAAM,oBAAoB,GAAuC;IAC/D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,UAAU,EAAE;QACV,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;QACjD,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KACrD;IACD,QAAQ,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,4BAA4B;IAClC,WAAW,EAAE,EAAE;IACf,OAAO,EAAE;QACP,OAAO,EAAsC,oBAAoB;KAClE;CACO,CAAC;AAEX,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAClD,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC"}
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,qBAAqB,EAAkB,MAAM,oBAAoB,CAAC;AAQ3E,MAAM,oBAAoB,GAAuC;IAC/D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,UAAU,EAAE;QACV,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;QACjD,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KACrD;IACD,QAAQ,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,4BAA4B;IAClC,WAAW,EAAE,EAAE;IACf,OAAO,EAAE;QACP,OAAO,EAAsC,oBAAoB;KAClE;CACO,CAAC;AAEX,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAClD,gEAAgE;AAChE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC"}

package/dist/src/tcgcadapter/adapter.d.ts

@@ -1,25 +1,97 @@
 import { EmitContext } from '@typespec/compiler';
 import { RustEmitterOptions } from '../lib.js';
 import * as rust from '../codemodel/index.js';
+/** Adapter converts the tcgc code model to a Rust Crate */
 export declare class Adapter {
+    /**
+     * Creates an Adapter for the specified EmitContext.
+     *
+     * @param context the compiler context from which to create the Adapter
+     * @returns
+     */
     static create(context: EmitContext<RustEmitterOptions>): Promise<Adapter>;
     private readonly crate;
     private readonly ctx;
     private readonly types;
     private readonly clientMethodParams;
     private constructor();
+    /** performs all the steps to convert tcgc to a crate */
     tcgcToCrate(): rust.Crate;
+    /** converts all tcgc types to their Rust type equivalent */
     private adaptTypes;
+    /**
+     * converts a tcgc enum to a Rust enum
+     *
+     * @param sdkEnum the tcgc enum to convert
+     * @returns a Rust enum
+     */
     private getEnum;
+    /**
+     * converts a tcgc model to a Rust model
+     *
+     * @param model the tcgc model to convert
+     * @returns a Rust model
+     */
     private getModel;
+    /**
+     * converts a tcgc model property to a model field
+     *
+     * @param property the tcgc model property to convert
+     * @param isPubMod indicates if the model is public
+     * @returns a Rust model field
+     */
     private getModelField;
+    /** converts a tcgc type to a Rust type */
     private getType;
+    /** returns the Rust unit type */
     private getUnitType;
+    /**
+     * converts a tcgc constant to a Rust literal
+     *
+     * @param constType the constant to convert
+     * @returns a Rust literal
+     */
     private getLiteral;
+    /** converts all tcgc clients and their methods into Rust clients/methods */
     private adaptClients;
+    /**
+     * recursively converts a client and its methods.
+     * this simplifies the case for hierarchical clients.
+     *
+     * @param client the tcgc client to recursively convert
+     * @param parent contains the parent Rust client when converting a child client
+     * @returns a Rust client
+     */
     private recursiveAdaptClient;
+    /**
+     * converts a tcgc method to a Rust method for the specified client
+     *
+     * @param method the tcgc method to convert
+     * @param rustClient the client to which the method belongs
+     */
     private adaptMethod;
+    /**
+     * converts a tcgc operation parameter into a Rust method parameter
+     *
+     * @param param the tcgc operation parameter to convert
+     * @returns a Rust method parameter
+     */
     private adaptMethodParameter;
-    private adaptSerdeFormat;
+    /**
+     * converts a tcgc spread parameter into a Rust partial body parameter.
+     *
+     * @param param the tcgc method parameter to convert
+     * @param format the wire format for the underlying body type
+     * @param opParamType the tcgc model to which the spread parameter belongs
+     * @returns a Rust partial body parameter
+     */
+    private adaptMethodSpreadParameter;
+    /**
+     * converts a Content-Type header value into a Rust body format
+     *
+     * @param contentType the value of the Content-Type header
+     * @returns a Rust body format
+     */
+    private adaptBodyFormat;
 }
 //# sourceMappingURL=adapter.d.ts.map

package/dist/src/tcgcadapter/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/tcgcadapter/adapter.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAC;AAG9C,qBAAa,OAAO;WACL,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAkB;IAGtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAG/C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoC;IAEvE,OAAO;IAcP,WAAW,IAAI,IAAI,CAAC,KAAK;IAiBzB,OAAO,CAAC,UAAU;IAuBlB,OAAO,CAAC,OAAO;IAqBf,OAAO,CAAC,QAAQ;IA2BhB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,OAAO;IAiIf,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,oBAAoB;IA0J5B,OAAO,CAAC,WAAW;IAmGnB,OAAO,CAAC,oBAAoB;IA4E5B,OAAO,CAAC,gBAAgB;CASzB"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/tcgcadapter/adapter.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAC;AAE9C,2DAA2D;AAC3D,qBAAa,OAAO;IAClB;;;;;OAKG;WACU,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAU/E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAkB;IAGtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAG/C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoC;IAEvE,OAAO;IAaP,wDAAwD;IACxD,WAAW,IAAI,IAAI,CAAC,KAAK;IAoCzB,4DAA4D;IAC5D,OAAO,CAAC,UAAU;IAqBlB;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAoBf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAgChB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAsBrB,0CAA0C;IAC1C,OAAO,CAAC,OAAO;IAiIf,iCAAiC;IACjC,OAAO,CAAC,WAAW;IAWnB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAWlB,4EAA4E;IAC5E,OAAO,CAAC,YAAY;IAcpB;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAwJ5B;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAqKnB;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IA6E5B;;;;;;;OAOG;IACH,OAAO,CAAC,0BAA0B;IA8BlC;;;;;OAKG;IACH,OAAO,CAAC,eAAe;CAcxB"}