X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-java;a=blobdiff_plain;f=ts%2Fstructs%2FType.mts;h=5c59cfb3900330c0e43280d6e27ce8a39aba5bff;hp=ac6bd670ce2ed0c7203375f7ab011f2767b3dfe0;hb=c629a01650402c8e2f9b9db8ced9ed63ce687727;hpb=d1d0121c000b713c10fd0bedd249eb8dda2e4db7 diff --git a/ts/structs/Type.mts b/ts/structs/Type.mts index ac6bd670..5c59cfb3 100644 --- a/ts/structs/Type.mts +++ b/ts/structs/Type.mts @@ -283,9 +283,16 @@ import * as bindings from '../bindings.mjs' +/** An implementation of Type */ export interface TypeInterface { + /**Returns the type identifying the message payload. + */ type_id(): number; + /**Return a human-readable "debug" string describing this object + */ debug_str(): string; + /**Serialize the object into a byte array + */ write(): Uint8Array; } @@ -293,6 +300,11 @@ class LDKTypeHolder { held: Type; } +/** + * Defines a type identifier for sending messages over the wire. + * + * Messages implementing this trait specify a type and must be [`Writeable`]. + */ export class Type extends CommonBase { /* @internal */ public bindings_instance?: bindings.LDKType; @@ -303,7 +315,8 @@ export class Type extends CommonBase { this.bindings_instance = null; } - static new_impl(arg: TypeInterface): Type { + /** Creates a new instance of Type from a given implementation */ + public static new_impl(arg: TypeInterface): Type { const impl_holder: LDKTypeHolder = new LDKTypeHolder(); let structImplementation = { type_id (): number { @@ -327,17 +340,27 @@ export class Type extends CommonBase { impl_holder.held.bindings_instance = structImplementation; return impl_holder.held; } + + /** + * Returns the type identifying the message payload. + */ public type_id(): number { const ret: number = bindings.Type_type_id(this.ptr); return ret; } + /** + * Return a human-readable "debug" string describing this object + */ public debug_str(): string { const ret: number = bindings.Type_debug_str(this.ptr); const ret_conv: string = bindings.decodeString(ret); return ret_conv; } + /** + * Serialize the object into a byte array + */ public write(): Uint8Array { const ret: number = bindings.Type_write(this.ptr); const ret_conv: Uint8Array = bindings.decodeUint8Array(ret); @@ -349,6 +372,9 @@ export class Type extends CommonBase { return ret; } + /** + * Creates a copy of a Type + */ public clone(): Type { const ret: number = bindings.Type_clone(this.ptr); const ret_hu_conv: Type = new Type(null, ret);