1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.buffer.d.ts 174.81 KB
一键复制 编辑 原始数据 按行查看 历史
suchongwei 提交于 2024-08-06 10:52 +08:00 . commonlibrary api doc add "@type"
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (The type of "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.
*/
/**
* @file
* @kit ArkTS
*/
/**
* The Buffer class is a global type for dealing with binary data directly. It can be constructed in a variety of ways.
*
* @namespace buffer
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The Buffer class is a global type for dealing with binary data directly. It can be constructed in a variety of ways.
*
* @namespace buffer
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The Buffer class is a global type for dealing with binary data directly. It can be constructed in a variety of ways.
*
* @namespace buffer
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace buffer {
/**
* This parameter specifies the type of a common encoding format.
*
* @typedef { 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex' }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* This parameter specifies the type of a common encoding format.
*
* @typedef { 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* This parameter specifies the type of a common encoding format.
*
* @typedef { 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
type BufferEncoding =
| 'ascii'
| 'utf8'
| 'utf-8'
| 'utf16le'
| 'ucs2'
| 'ucs-2'
| 'base64'
| 'base64url'
| 'latin1'
| 'binary'
| 'hex';
/**
* TypedArray inherits the features and methods of Int8Array
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* TypedArray inherits the features and methods of Int8Array
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* TypedArray inherits the features and methods of Int8Array
*
* @interface TypedArray
* @extends Int8Array
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
interface TypedArray extends Int8Array {}
/**
* Allocates a new Buffer for a fixed size bytes. If fill is undefined, the Buffer will be zero-filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @param { string | Buffer | number } [fill] - fill [fill=0] A value to pre-fill the new Buffer with
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `fill` is a string, this is its encoding
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Allocates a new Buffer for a fixed size bytes. If fill is undefined, the Buffer will be zero-filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @param { string | Buffer | number } [fill] - fill [fill=0] A value to pre-fill the new Buffer with
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `fill` is a string, this is its encoding
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Allocates a new Buffer for a fixed size bytes. If fill is undefined, the Buffer will be zero-filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @param { string | Buffer | number } [fill] - fill [fill=0] A value to pre-fill the new Buffer with
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `fill` is a string, this is its encoding
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer;
/**
* Allocates a new Buffer for a fixed size bytes. The Buffer will not be initially filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Allocates a new Buffer for a fixed size bytes. The Buffer will not be initially filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Allocates a new Buffer for a fixed size bytes. The Buffer will not be initially filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function allocUninitializedFromPool(size: number): Buffer;
/**
* Allocates a new un-pooled Buffer for a fixed size bytes. The Buffer will not be initially filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Allocates a new un-pooled Buffer for a fixed size bytes. The Buffer will not be initially filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Allocates a new un-pooled Buffer for a fixed size bytes. The Buffer will not be initially filled.
*
* @param { number } size - size size The desired length of the new Buffer
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function allocUninitialized(size: number): Buffer;
/**
* Returns the byte length of a string when encoded using `encoding`.
* This is not the same as [`String.prototype.length`], which does not account
* for the encoding that is used to convert the string into bytes.
*
* @param { string | Buffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer } string - string string A value to calculate the length of
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `string` is a string, this is its encoding
* @returns { number } The number of bytes contained within `string`
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns the byte length of a string when encoded using `encoding`.
* This is not the same as [`String.prototype.length`], which does not account
* for the encoding that is used to convert the string into bytes.
*
* @param { string | Buffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer } string - string string A value to calculate the length of
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `string` is a string, this is its encoding
* @returns { number } The number of bytes contained within `string`
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the byte length of a string when encoded using `encoding`.
* This is not the same as [`String.prototype.length`], which does not account
* for the encoding that is used to convert the string into bytes.
*
* @param { string | Buffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer } string - string string A value to calculate the length of
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `string` is a string, this is its encoding
* @returns { number } The number of bytes contained within `string`
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function byteLength(
string: string | Buffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer,
encoding?: BufferEncoding
): number;
/**
* Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
*
* @param { Buffer[] | Uint8Array[] } list - list list List of `Buffer` or Uint8Array instances to concatenate
* @param { number } [totalLength] - totalLength totalLength Total length of the `Buffer` instances in `list` when concatenated
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "length" is out of range. It must be >= 0 and <= uint32 max. Received value is: [length]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
*
* @param { Buffer[] | Uint8Array[] } list - list list List of `Buffer` or Uint8Array instances to concatenate
* @param { number } [totalLength] - totalLength totalLength Total length of the `Buffer` instances in `list` when concatenated
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "length" is out of range. It must be >= 0 and <= uint32 max. Received value is: [length]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
*
* @param { Buffer[] | Uint8Array[] } list - list list List of `Buffer` or Uint8Array instances to concatenate
* @param { number } [totalLength] - totalLength totalLength Total length of the `Buffer` instances in `list` when concatenated
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "length" is out of range. It must be >= 0 and <= uint32 max. Received value is: [length]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function concat(list: Buffer[] | Uint8Array[], totalLength?: number): Buffer;
/**
* Allocates a new Buffer using an array of bytes in the range 0 – 255. Array entries outside that range will be truncated to fit into it.
*
* @param { number[] } array - array array an array of bytes in the range 0 – 255
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Allocates a new Buffer using an array of bytes in the range 0 – 255. Array entries outside that range will be truncated to fit into it.
*
* @param { number[] } array - array array an array of bytes in the range 0 – 255
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Allocates a new Buffer using an array of bytes in the range 0 – 255. Array entries outside that range will be truncated to fit into it.
*
* @param { number[] } array - array array an array of bytes in the range 0 – 255
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function from(array: number[]): Buffer;
/**
* This creates a view of the ArrayBuffer without copying the underlying memory.
*
* @param { ArrayBuffer | SharedArrayBuffer } arrayBuffer - arrayBuffer arrayBuffer An ArrayBuffer,
* SharedArrayBuffer, for example the .buffer property of a TypedArray.
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Index of first byte to expose
* @param { number } [length] - length [length = arrayBuffer.byteLength - byteOffset] Number of bytes to expose
* @returns { Buffer } Return a view of the ArrayBuffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[byteOffset/length]" is out of range.
* It must be >= [left range] and <= [right range]. Received value is: [byteOffset/length]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* This creates a view of the ArrayBuffer without copying the underlying memory.
*
* @param { ArrayBuffer | SharedArrayBuffer } arrayBuffer - arrayBuffer arrayBuffer An ArrayBuffer,
* SharedArrayBuffer, for example the .buffer property of a TypedArray.
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Index of first byte to expose
* @param { number } [length] - length [length = arrayBuffer.byteLength - byteOffset] Number of bytes to expose
* @returns { Buffer } Return a view of the ArrayBuffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[byteOffset/length]" is out of range.
* It must be >= [left range] and <= [right range]. Received value is: [byteOffset/length]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* This creates a view of the ArrayBuffer without copying the underlying memory.
*
* @param { ArrayBuffer | SharedArrayBuffer } arrayBuffer - arrayBuffer arrayBuffer An ArrayBuffer,
* SharedArrayBuffer, for example the .buffer property of a TypedArray.
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Index of first byte to expose
* @param { number } [length] - length [length = arrayBuffer.byteLength - byteOffset] Number of bytes to expose
* @returns { Buffer } Return a view of the ArrayBuffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[byteOffset/length]" is out of range.
* It must be >= [left range] and <= [right range]. Received value is: [byteOffset/length]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): Buffer;
/**
* Copies the passed buffer data onto a new Buffer instance.
*
* @param { Buffer | Uint8Array } buffer - buffer buffer An existing Buffer or Uint8Array from which to copy data
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Copies the passed buffer data onto a new Buffer instance.
*
* @param { Buffer | Uint8Array } buffer - buffer buffer An existing Buffer or Uint8Array from which to copy data
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Copies the passed buffer data onto a new Buffer instance.
*
* @param { Buffer | Uint8Array } buffer - buffer buffer An existing Buffer or Uint8Array from which to copy data
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function from(buffer: Buffer | Uint8Array): Buffer;
/**
* For the object whose value returned by valueof() function is strictly equal to object
* or supports symbol To primitive object, a new buffer instance is created.
*
* @param { Object } object - object object An object supporting Symbol.toPrimitive or valueOf()
* @param { number | string } offsetOrEncoding - offsetOrEncoding offsetOrEncoding A byte-offset or encoding
* @param { number } length - length length A length
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* For the object whose value returned by valueof() function is strictly equal to object
* or supports symbol To primitive object, a new buffer instance is created.
*
* @param { Object } object - object object An object supporting Symbol.toPrimitive or valueOf()
* @param { number | string } offsetOrEncoding - offsetOrEncoding offsetOrEncoding A byte-offset or encoding
* @param { number } length - length length A length
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* For the object whose value returned by valueof() function is strictly equal to object
* or supports symbol To primitive object, a new buffer instance is created.
*
* @param { Object } object - object object An object supporting Symbol.toPrimitive or valueOf()
* @param { number | string } offsetOrEncoding - offsetOrEncoding offsetOrEncoding A byte-offset or encoding
* @param { number } length - length length A length
* @returns { Buffer } Return a new allocated Buffer
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function from(object: Object, offsetOrEncoding: number | string, length: number): Buffer;
/**
* Creates a new Buffer containing string. The encoding parameter identifies the character encoding
* to be used when converting string into bytes.
*
* @param { String } string - string string A string to encode
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The encoding of string
* @returns { Buffer } Return a new Buffer containing string
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates a new Buffer containing string. The encoding parameter identifies the character encoding
* to be used when converting string into bytes.
*
* @param { String } string - string string A string to encode
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The encoding of string
* @returns { Buffer } Return a new Buffer containing string
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates a new Buffer containing string. The encoding parameter identifies the character encoding
* to be used when converting string into bytes.
*
* @param { String } string - string string A string to encode
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The encoding of string
* @returns { Buffer } Return a new Buffer containing string
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function from(string: String, encoding?: BufferEncoding): Buffer;
/**
* Returns true if obj is a Buffer, false otherwise
*
* @param { Object } obj - obj obj Objects to be judged
* @returns { boolean } true or false
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns true if obj is a Buffer, false otherwise
*
* @param { Object } obj - obj obj Objects to be judged
* @returns { boolean } true or false
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns true if obj is a Buffer, false otherwise
*
* @param { Object } obj - obj obj Objects to be judged
* @returns { boolean } true or false
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function isBuffer(obj: Object): boolean;
/**
* Returns true if encoding is the name of a supported character encoding, or false otherwise.
*
* @param { string } encoding - encoding encoding A character encoding name to check
* @returns { boolean } true or false
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns true if encoding is the name of a supported character encoding, or false otherwise.
*
* @param { string } encoding - encoding encoding A character encoding name to check
* @returns { boolean } true or false
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns true if encoding is the name of a supported character encoding, or false otherwise.
*
* @param { string } encoding - encoding encoding A character encoding name to check
* @returns { boolean } true or false
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function isEncoding(encoding: string): boolean;
/**
* Compares buf1 to buf2
*
* @param { Buffer | Uint8Array } buf1 - buf1 buf1 A Buffer or Uint8Array instance.
* @param { Buffer | Uint8Array } buf2 - buf2 buf2 A Buffer or Uint8Array instance.
* @returns { -1 | 0 | 1 } 0 is returned if target is the same as buf
* 1 is returned if target should come before buf when sorted.
* -1 is returned if target should come after buf when sorted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Compares buf1 to buf2
*
* @param { Buffer | Uint8Array } buf1 - buf1 buf1 A Buffer or Uint8Array instance.
* @param { Buffer | Uint8Array } buf2 - buf2 buf2 A Buffer or Uint8Array instance.
* @returns { -1 | 0 | 1 } 0 is returned if target is the same as buf
* 1 is returned if target should come before buf when sorted.
* -1 is returned if target should come after buf when sorted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Compares buf1 to buf2
*
* @param { Buffer | Uint8Array } buf1 - buf1 buf1 A Buffer or Uint8Array instance.
* @param { Buffer | Uint8Array } buf2 - buf2 buf2 A Buffer or Uint8Array instance.
* @returns { -1 | 0 | 1 } 0 is returned if target is the same as buf
* 1 is returned if target should come before buf when sorted.
* -1 is returned if target should come after buf when sorted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function compare(buf1: Buffer | Uint8Array, buf2: Buffer | Uint8Array): -1 | 0 | 1;
/**
* Re-encodes the given Buffer or Uint8Array instance from one character encoding to another.
*
* @param { Buffer | Uint8Array } source - source source A Buffer or Uint8Array instance.
* @param { string } fromEnc - fromEnc fromEnc The current encoding
* @param { string } toEnc - toEnc toEnc To target encoding
* @returns { Buffer } Returns a new Buffer instance
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Re-encodes the given Buffer or Uint8Array instance from one character encoding to another.
*
* @param { Buffer | Uint8Array } source - source source A Buffer or Uint8Array instance.
* @param { string } fromEnc - fromEnc fromEnc The current encoding
* @param { string } toEnc - toEnc toEnc To target encoding
* @returns { Buffer } Returns a new Buffer instance
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Re-encodes the given Buffer or Uint8Array instance from one character encoding to another.
*
* @param { Buffer | Uint8Array } source - source source A Buffer or Uint8Array instance.
* @param { string } fromEnc - fromEnc fromEnc The current encoding
* @param { string } toEnc - toEnc toEnc To target encoding
* @returns { Buffer } Returns a new Buffer instance
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
function transcode(source: Buffer | Uint8Array, fromEnc: string, toEnc: string): Buffer;
/**
* The Buffer object is a method of handling buffers dedicated to binary data.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The Buffer object is a method of handling buffers dedicated to binary data.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The Buffer object is a method of handling buffers dedicated to binary data.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class Buffer {
/**
* Returns the number of bytes in buf
*
* @type { number }
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns the number of bytes in buf
*
* @type { number }
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the number of bytes in buf
*
* @type { number }
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
length: number;
/**
* The underlying ArrayBuffer object based on which this Buffer object is created.
*
* @type { ArrayBuffer }
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The underlying ArrayBuffer object based on which this Buffer object is created.
*
* @type { ArrayBuffer }
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The underlying ArrayBuffer object based on which this Buffer object is created.
*
* @type { ArrayBuffer }
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
buffer: ArrayBuffer;
/**
* The byteOffset of the Buffers underlying ArrayBuffer object
*
* @type { number }
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The byteOffset of the Buffers underlying ArrayBuffer object
*
* @type { number }
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The byteOffset of the Buffers underlying ArrayBuffer object
*
* @type { number }
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
byteOffset: number;
/**
* Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled.
*
* @param { string | Buffer | Uint8Array | number } value - value value The value with which to fill buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to fill buf
* @param { number } [end] - end [end = buf.length] Where to stop filling buf (not inclusive)
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The encoding for value if value is a string
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200001 - The value of "[offset/end]" is out of range. It must be >= 0 and <= [right range]. Received value is: [offset/end]
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled.
*
* @param { string | Buffer | Uint8Array | number } value - value value The value with which to fill buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to fill buf
* @param { number } [end] - end [end = buf.length] Where to stop filling buf (not inclusive)
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The encoding for value if value is a string
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200001 - The value of "[offset/end]" is out of range. It must be >= 0 and <= [right range]. Received value is: [offset/end]
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled.
*
* @param { string | Buffer | Uint8Array | number } value - value value The value with which to fill buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to fill buf
* @param { number } [end] - end [end = buf.length] Where to stop filling buf (not inclusive)
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The encoding for value if value is a string
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200001 - The value of "[offset/end]" is out of range. It must be >= 0 and <= [right range]. Received value is: [offset/end]
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
fill(
value: string | Buffer | Uint8Array | number,
offset?: number,
end?: number,
encoding?: BufferEncoding
): Buffer;
/**
* Compares buf with target and returns a number indicating whether buf comes before, after,
* or is the same as target in sort order. Comparison is based on the actual sequence of bytes in each Buffer.
*
* @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array with which to compare buf
* @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin comparison
* @param { number } [targetEnd] - targetEnd [targetEnd = target.length] The offset within target at which to end comparison (not inclusive)
* @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf at which to begin comparison
* @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to end comparison (not inclusive)
* @returns { -1 | 0 | 1 } 0 is returned if target is the same as buf
* 1 is returned if target should come before buf when sorted.
* -1 is returned if target should come after buf when sorted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[targetStart/targetEnd/sourceStart/sourceEnd]" is out of range.
* It must be >= 0 and <= [right range]. Received value is: [targetStart/targetEnd/sourceStart/sourceEnd]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Compares buf with target and returns a number indicating whether buf comes before, after,
* or is the same as target in sort order. Comparison is based on the actual sequence of bytes in each Buffer.
*
* @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array with which to compare buf
* @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin comparison
* @param { number } [targetEnd] - targetEnd [targetEnd = target.length] The offset within target at which to end comparison (not inclusive)
* @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf at which to begin comparison
* @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to end comparison (not inclusive)
* @returns { -1 | 0 | 1 } 0 is returned if target is the same as buf
* 1 is returned if target should come before buf when sorted.
* -1 is returned if target should come after buf when sorted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[targetStart/targetEnd/sourceStart/sourceEnd]" is out of range.
* It must be >= 0 and <= [right range]. Received value is: [targetStart/targetEnd/sourceStart/sourceEnd]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Compares buf with target and returns a number indicating whether buf comes before, after,
* or is the same as target in sort order. Comparison is based on the actual sequence of bytes in each Buffer.
*
* @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array with which to compare buf
* @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin comparison
* @param { number } [targetEnd] - targetEnd [targetEnd = target.length] The offset within target at which to end comparison (not inclusive)
* @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf at which to begin comparison
* @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to end comparison (not inclusive)
* @returns { -1 | 0 | 1 } 0 is returned if target is the same as buf
* 1 is returned if target should come before buf when sorted.
* -1 is returned if target should come after buf when sorted.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[targetStart/targetEnd/sourceStart/sourceEnd]" is out of range.
* It must be >= 0 and <= [right range]. Received value is: [targetStart/targetEnd/sourceStart/sourceEnd]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
compare(
target: Buffer | Uint8Array,
targetStart?: number,
targetEnd?: number,
sourceStart?: number,
sourceEnd?: number
): -1 | 0 | 1;
/**
* Copies data from a region of buf to a region in target, even if the target memory region overlaps with buf.
* If sourceEnd is greater than the length of the target, the length of the target shall prevail, and the extra part will not be overwritten.
*
* @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array to copy into
* @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin writing
* @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf from which to begin copying
* @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to stop copying (not inclusive)
* @returns { number } The number of bytes copied
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[targetStart/sourceStart/sourceEnd]" is out of range. It must be >= 0.
* Received value is: [targetStart/sourceStart/sourceEnd]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Copies data from a region of buf to a region in target, even if the target memory region overlaps with buf.
* If sourceEnd is greater than the length of the target, the length of the target shall prevail, and the extra part will not be overwritten.
*
* @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array to copy into
* @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin writing
* @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf from which to begin copying
* @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to stop copying (not inclusive)
* @returns { number } The number of bytes copied
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[targetStart/sourceStart/sourceEnd]" is out of range. It must be >= 0.
* Received value is: [targetStart/sourceStart/sourceEnd]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Copies data from a region of buf to a region in target, even if the target memory region overlaps with buf.
* If sourceEnd is greater than the length of the target, the length of the target shall prevail, and the extra part will not be overwritten.
*
* @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array to copy into
* @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin writing
* @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf from which to begin copying
* @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to stop copying (not inclusive)
* @returns { number } The number of bytes copied
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[targetStart/sourceStart/sourceEnd]" is out of range. It must be >= 0.
* Received value is: [targetStart/sourceStart/sourceEnd]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
copy(target: Buffer | Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
/**
* Returns true if both buf and otherBuffer have exactly the same bytes, false otherwise
*
* @param { Uint8Array | Buffer } otherBuffer - otherBuffer otherBuffer A Buffer or Uint8Array with which to compare buf
* @returns { boolean } true or false
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns true if both buf and otherBuffer have exactly the same bytes, false otherwise
*
* @param { Uint8Array | Buffer } otherBuffer - otherBuffer otherBuffer A Buffer or Uint8Array with which to compare buf
* @returns { boolean } true or false
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns true if both buf and otherBuffer have exactly the same bytes, false otherwise
*
* @param { Uint8Array | Buffer } otherBuffer - otherBuffer otherBuffer A Buffer or Uint8Array with which to compare buf
* @returns { boolean } true or false
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
equals(otherBuffer: Uint8Array | Buffer): boolean;
/**
* Returns true if value was found in buf, false otherwise
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf. If negative, then offset is calculated from the end of buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string, this is its encoding
* @returns { boolean } true or false
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns true if value was found in buf, false otherwise
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf. If negative, then offset is calculated from the end of buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string, this is its encoding
* @returns { boolean } true or false
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns true if value was found in buf, false otherwise
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf. If negative, then offset is calculated from the end of buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string, this is its encoding
* @returns { boolean } true or false
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
includes(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): boolean;
/**
* The index of the first occurrence of value in buf
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string,
* this is the encoding used to determine the binary representation of the string that will be searched for in buf
* @returns { number } The index of the first occurrence of value in buf, or -1 if buf does not contain value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The index of the first occurrence of value in buf
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string,
* this is the encoding used to determine the binary representation of the string that will be searched for in buf
* @returns { number } The index of the first occurrence of value in buf, or -1 if buf does not contain value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The index of the first occurrence of value in buf
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string,
* this is the encoding used to determine the binary representation of the string that will be searched for in buf
* @returns { number } The index of the first occurrence of value in buf, or -1 if buf does not contain value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
indexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
/**
* Creates and returns an iterator of buf keys (indices).
*
* @returns { IterableIterator<number> }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates and returns an iterator of buf keys (indices).
*
* @returns { IterableIterator<number> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates and returns an iterator of buf keys (indices).
*
* @returns { IterableIterator<number> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
keys(): IterableIterator<number>;
/**
* Creates and returns an iterator for buf values (bytes).
*
* @returns { IterableIterator<number> }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates and returns an iterator for buf values (bytes).
*
* @returns { IterableIterator<number> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates and returns an iterator for buf values (bytes).
*
* @returns { IterableIterator<number> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
values(): IterableIterator<number>;
/**
* Creates and returns an iterator of [index, byte] pairs from the contents of buf.
*
* @returns { IterableIterator<[number, number]> }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates and returns an iterator of [index, byte] pairs from the contents of buf.
*
* @returns { IterableIterator<[number, number]> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates and returns an iterator of [index, byte] pairs from the contents of buf.
*
* @returns { IterableIterator<[number, number]> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
entries(): IterableIterator<[number, number]>;
/**
* The index of the last occurrence of value in buf
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string,
* this is the encoding used to determine the binary representation of the string that will be searched for in buf
* @returns { number } The index of the last occurrence of value in buf, or -1 if buf does not contain value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The index of the last occurrence of value in buf
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string,
* this is the encoding used to determine the binary representation of the string that will be searched for in buf
* @returns { number } The index of the last occurrence of value in buf, or -1 if buf does not contain value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The index of the last occurrence of value in buf
*
* @param { string | number | Buffer | Uint8Array } value - value value What to search for
* @param { number } [byteOffset] - byteOffset [byteOffset = 0] Where to begin searching in buf
* @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If value is a string,
* this is the encoding used to determine the binary representation of the string that will be searched for in buf
* @returns { number } The index of the last occurrence of value in buf, or -1 if buf does not contain value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
lastIndexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
/**
* Reads a signed, big-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a signed, big-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed, big-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a signed, big-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed, big-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a signed, big-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readBigInt64BE(offset?: number): bigint;
/**
* Reads a signed, little-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a signed, little-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed, little-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a signed, little-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed, little-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a signed, little-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readBigInt64LE(offset?: number): bigint;
/**
* Reads a unsigned, big-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a unsigned, big-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a unsigned, big-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a unsigned, big-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a unsigned, big-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a unsigned, big-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readBigUInt64BE(offset?: number): bigint;
/**
* Reads a unsigned, little-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a unsigned, little-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a unsigned, little-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a unsigned, little-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a unsigned, little-endian 64-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { bigint } Return a unsigned, little-endian 64-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readBigUInt64LE(offset?: number): bigint;
/**
* Reads a 64-bit, big-endian double from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } Return a 64-bit, big-endian double
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a 64-bit, big-endian double from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } Return a 64-bit, big-endian double
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a 64-bit, big-endian double from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } Return a 64-bit, big-endian double
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readDoubleBE(offset?: number): number;
/**
* Reads a 64-bit, little-endian double from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } Return a 64-bit, little-endian double
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a 64-bit, little-endian double from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } Return a 64-bit, little-endian double
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a 64-bit, little-endian double from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } Return a 64-bit, little-endian double
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readDoubleLE(offset?: number): number;
/**
* Reads a 32-bit, big-endian float from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a 32-bit, big-endian float
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a 32-bit, big-endian float from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a 32-bit, big-endian float
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a 32-bit, big-endian float from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a 32-bit, big-endian float
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readFloatBE(offset?: number): number;
/**
* Reads a 32-bit, little-endian float from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a 32-bit, little-endian float
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a 32-bit, little-endian float from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a 32-bit, little-endian float
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a 32-bit, little-endian float from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a 32-bit, little-endian float
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readFloatLE(offset?: number): number;
/**
* Reads a signed 8-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 1
* @returns { number } Return a signed 8-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed 8-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 1
* @returns { number } Return a signed 8-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed 8-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 1
* @returns { number } Return a signed 8-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readInt8(offset?: number): number;
/**
* Reads a signed, big-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } Return a signed, big-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed, big-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } Return a signed, big-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed, big-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } Return a signed, big-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readInt16BE(offset?: number): number;
/**
* Reads a signed, little-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } Return a signed, little-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed, little-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } Return a signed, little-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed, little-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } Return a signed, little-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readInt16LE(offset?: number): number;
/**
* Reads a signed, big-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a signed, big-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed, big-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a signed, big-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed, big-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a signed, big-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readInt32BE(offset?: number): number;
/**
* Reads a signed, little-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a signed, little-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads a signed, little-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a signed, little-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads a signed, little-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } Return a signed, little-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readInt32LE(offset?: number): number;
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as a big-endian,
* two's complement signed value supporting up to 48 bits of accuracy
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as a big-endian,
* two's complement signed value supporting up to 48 bits of accuracy
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as a big-endian,
* two's complement signed value supporting up to 48 bits of accuracy
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readIntBE(offset: number, byteLength: number): number;
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as a little-endian,
* two's complement signed value supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as a little-endian,
* two's complement signed value supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as a little-endian,
* two's complement signed value supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readIntLE(offset: number, byteLength: number): number;
/**
* Reads an unsigned 8-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
* @returns { number } Reads an unsigned 8-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads an unsigned 8-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
* @returns { number } Reads an unsigned 8-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads an unsigned 8-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
* @returns { number } Reads an unsigned 8-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUInt8(offset?: number): number;
/**
* Reads an unsigned, big-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } Reads an unsigned, big-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads an unsigned, big-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } Reads an unsigned, big-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads an unsigned, big-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } Reads an unsigned, big-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUInt16BE(offset?: number): number;
/**
* Reads an unsigned, little-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } Reads an unsigned, little-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads an unsigned, little-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } Reads an unsigned, little-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads an unsigned, little-endian 16-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } Reads an unsigned, little-endian 16-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUInt16LE(offset?: number): number;
/**
* Reads an unsigned, big-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } Reads an unsigned, big-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads an unsigned, big-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } Reads an unsigned, big-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads an unsigned, big-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } Reads an unsigned, big-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUInt32BE(offset?: number): number;
/**
* Reads an unsigned, little-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } Reads an unsigned, little-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads an unsigned, little-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } Reads an unsigned, little-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads an unsigned, little-endian 32-bit integer from buf at the specified offset
*
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } Reads an unsigned, little-endian 32-bit integer
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUInt32LE(offset?: number): number;
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as
* an unsigned big-endian integer supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as
* an unsigned big-endian integer supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as
* an unsigned big-endian integer supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUIntBE(offset: number, byteLength: number): number;
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as an unsigned,
* little-endian integer supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as an unsigned,
* little-endian integer supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Reads byteLength number of bytes from buf at the specified offset and interprets the result as an unsigned,
* little-endian integer supporting up to 48 bits of accuracy.
*
* @param { number } offset - offset offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6
* @returns { number }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readUIntLE(offset: number, byteLength: number): number;
/**
* Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.
*
* @param { number } [start] - start [start = 0] Where the new Buffer will start
* @param { number } [end] - end [end = buf.length] Where the new Buffer will end (not inclusive)
* @returns { Buffer } Returns a new Buffer that references the same memory as the original
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.
*
* @param { number } [start] - start [start = 0] Where the new Buffer will start
* @param { number } [end] - end [end = buf.length] Where the new Buffer will end (not inclusive)
* @returns { Buffer } Returns a new Buffer that references the same memory as the original
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.
*
* @param { number } [start] - start [start = 0] Where the new Buffer will start
* @param { number } [end] - end [end = buf.length] Where the new Buffer will end (not inclusive)
* @returns { Buffer } Returns a new Buffer that references the same memory as the original
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
subarray(start?: number, end?: number): Buffer;
/**
* Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 16-bits
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 16-bits
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 16-bits
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
swap16(): Buffer;
/**
* Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 32-bits
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 32-bits
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 32-bits
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
swap32(): Buffer;
/**
* Interprets buf as an array of unsigned 64-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 64-bits
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Interprets buf as an array of unsigned 64-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 64-bits
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Interprets buf as an array of unsigned 64-bit integers and swaps the byte order in-place.
*
* @returns { Buffer } A reference to buf
* @throws { BusinessError } 10200009 - The buffer size must be a multiple of 64-bits
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
swap64(): Buffer;
/**
* Returns a JSON representation of buf
*
* @returns { Object } Returns a JSON
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a JSON representation of buf
*
* @returns { Object } Returns a JSON
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a JSON representation of buf
*
* @returns { Object } Returns a JSON
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
toJSON(): Object;
/**
* Decodes buf to a string according to the specified character encoding in encoding
*
* @param { string } [encoding] - encoding [encoding='utf8'] The character encoding to use
* @param { number } [start] - start [start = 0] The byte offset to start decoding at
* @param { number } [end] - end [end = buf.length] The byte offset to stop decoding at (not inclusive)
* @returns { string }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Decodes buf to a string according to the specified character encoding in encoding
*
* @param { string } [encoding] - encoding [encoding='utf8'] The character encoding to use
* @param { number } [start] - start [start = 0] The byte offset to start decoding at
* @param { number } [end] - end [end = buf.length] The byte offset to stop decoding at (not inclusive)
* @returns { string }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Decodes buf to a string according to the specified character encoding in encoding
*
* @param { string } [encoding] - encoding [encoding='utf8'] The character encoding to use
* @param { number } [start] - start [start = 0] The byte offset to start decoding at
* @param { number } [end] - end [end = buf.length] The byte offset to stop decoding at (not inclusive)
* @returns { string }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
toString(encoding?: string, start?: number, end?: number): string;
/**
* Writes string to buf at offset according to the character encoding in encoding
*
* @param { string } str - str str Writes string to buf at offset according to the character encoding in encoding
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write string
* @param { number } [length] - length [length = buf.length - offset] Maximum number of bytes to write (written bytes will not exceed buf.length - offset)
* @param { string } [encoding] - encoding [encoding='utf8'] The character encoding of string.
* @returns { number } Number of bytes written.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[offset/length]" is out of range. It must be >= 0 and <= buf.length. Received value is: [offset/length]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes string to buf at offset according to the character encoding in encoding
*
* @param { string } str - str str Writes string to buf at offset according to the character encoding in encoding
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write string
* @param { number } [length] - length [length = buf.length - offset] Maximum number of bytes to write (written bytes will not exceed buf.length - offset)
* @param { string } [encoding] - encoding [encoding='utf8'] The character encoding of string.
* @returns { number } Number of bytes written.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[offset/length]" is out of range. It must be >= 0 and <= buf.length. Received value is: [offset/length]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes string to buf at offset according to the character encoding in encoding
*
* @param { string } str - str str Writes string to buf at offset according to the character encoding in encoding
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write string
* @param { number } [length] - length [length = buf.length - offset] Maximum number of bytes to write (written bytes will not exceed buf.length - offset)
* @param { string } [encoding] - encoding [encoding='utf8'] The character encoding of string.
* @returns { number } Number of bytes written.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[offset/length]" is out of range. It must be >= 0 and <= buf.length. Received value is: [offset/length]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
write(str: string, offset?: number, length?: number, encoding?: string): number;
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeBigInt64BE(value: bigint, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeBigInt64LE(value: bigint, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeBigUInt64BE(value: bigint, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { bigint } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeBigUInt64LE(value: bigint, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeDoubleBE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeDoubleLE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeFloatBE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeFloatLE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset. value must be a valid signed 8-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 1
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset. value must be a valid signed 8-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 1
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset. value must be a valid signed 8-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 1
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeInt8(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid signed 16-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid signed 16-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid signed 16-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeInt16BE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid signed 16-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid signed 16-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid signed 16-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeInt16LE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid signed 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid signed 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid signed 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeInt32BE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid signed 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid signed 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid signed 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeInt32LE(value: number, offset?: number): number;
/**
* Writes byteLength bytes of value to buf at the specified offset as big-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as big-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as big-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeIntBE(value: number, offset: number, byteLength: number): number;
/**
* Writes byteLength bytes of value to buf at the specified offset as little-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as little-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as little-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeIntLE(value: number, offset: number, byteLength: number): number;
/**
* Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUInt8(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid unsigned 16-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid unsigned 16-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid unsigned 16-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUInt16BE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid unsigned 16-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid unsigned 16-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid unsigned 16-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUInt16LE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid unsigned 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid unsigned 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as big-endian. The value must be a valid unsigned 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUInt32BE(value: number, offset?: number): number;
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid unsigned 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid unsigned 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes value to buf at the specified offset as little-endian. The value must be a valid unsigned 32-bit integer.
*
* @param { number } value - value value Number to be written to buf
* @param { number } [offset] - offset [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUInt32LE(value: number, offset?: number): number;
/**
* Writes byteLength bytes of value to buf at the specified offset as big-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as big-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as big-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUIntBE(value: number, offset: number, byteLength: number): number;
/**
* Writes byteLength bytes of value to buf at the specified offset as little-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as little-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes byteLength bytes of value to buf at the specified offset as little-endian
*
* @param { number } value - value value Number to be written to buf
* @param { number } offset - offset offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength
* @param { number } byteLength - byteLength byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6
* @returns { number } offset plus the number of bytes written
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
writeUIntLE(value: number, offset: number, byteLength: number): number;
}
/**
* Process data as blob type
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Process data as blob type
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Process data as blob type
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class Blob {
/**
* Creates a new Blob object containing a concatenation of the given sources.
*
* @param { string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[] } sources - sources sources An array of string, <ArrayBuffer>,
* <TypedArray>, <DataView>, or <Blob> objects, or any mix of such objects, that will be stored within the Blob
* @param { Object } [options] - options options {endings: string, type: string}
* endings: One of either 'transparent' or 'native'.
* type: The Blob content-type
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates a new Blob object containing a concatenation of the given sources.
*
* @param { string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[] } sources - sources sources An array of string, <ArrayBuffer>,
* <TypedArray>, <DataView>, or <Blob> objects, or any mix of such objects, that will be stored within the Blob
* @param { Object } [options] - options options {endings: string, type: string}
* endings: One of either 'transparent' or 'native'.
* type: The Blob content-type
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates a new Blob object containing a concatenation of the given sources.
*
* @param { string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[] } sources - sources sources An array of string, <ArrayBuffer>,
* <TypedArray>, <DataView>, or <Blob> objects, or any mix of such objects, that will be stored within the Blob
* @param { Object } [options] - options options {endings: string, type: string}
* endings: One of either 'transparent' or 'native'.
* type: The Blob content-type
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(sources: string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[], options?: Object);
/**
* The total size of the Blob in bytes
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The total size of the Blob in bytes
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The total size of the Blob in bytes
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
size: number;
/**
* The content-type of the Blob
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The content-type of the Blob
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The content-type of the Blob
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
type: string;
/**
* Returns a promise that fulfills with an <ArrayBuffer> containing a copy of the Blob data.
*
* @returns { Promise<ArrayBuffer> }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a promise that fulfills with an <ArrayBuffer> containing a copy of the Blob data.
*
* @returns { Promise<ArrayBuffer> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a promise that fulfills with an <ArrayBuffer> containing a copy of the Blob data.
*
* @returns { Promise<ArrayBuffer> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
arrayBuffer(): Promise<ArrayBuffer>;
/**
* Creates and returns a new Blob containing a subset of this Blob objects data. The original Blob is not altered
*
* @param { number } [start] - start start The starting index
* @param { number } [end] - end end The ending index
* @param { string } [type] - type type The content-type for the new Blob
* @returns { Blob }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates and returns a new Blob containing a subset of this Blob objects data. The original Blob is not altered
*
* @param { number } [start] - start start The starting index
* @param { number } [end] - end end The ending index
* @param { string } [type] - type type The content-type for the new Blob
* @returns { Blob }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates and returns a new Blob containing a subset of this Blob objects data. The original Blob is not altered
*
* @param { number } [start] - start start The starting index
* @param { number } [end] - end end The ending index
* @param { string } [type] - type type The content-type for the new Blob
* @returns { Blob }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
slice(start?: number, end?: number, type?: string): Blob;
/**
* Returns a promise that fulfills with the contents of the Blob decoded as a UTF-8 string.
*
* @returns { Promise<string> }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a promise that fulfills with the contents of the Blob decoded as a UTF-8 string.
*
* @returns { Promise<string> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a promise that fulfills with the contents of the Blob decoded as a UTF-8 string.
*
* @returns { Promise<string> }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
text(): Promise<string>;
}
}
export default buffer;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助