From d0bc9b57ce572c885a90ab9834573d096883250d Mon Sep 17 00:00:00 2001 From: hu-kai45 Date: Mon, 3 Jul 2023 11:50:42 +0800 Subject: [PATCH] =?UTF-8?q?README=20=E6=95=B4=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: hu-kai45 --- README.md | 9 ++++++++- README_zh.md | 8 +++++++- figures/inner_structure.png | Bin 0 -> 13611 bytes 3 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 figures/inner_structure.png diff --git a/README.md b/README.md index 789401b..318b40b 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,14 @@ upper layer applications recommend HTTP communication capabilities. `ylong_http` is written in the Rust language to support OpenHarmony's Rust capability. -## Structure +**Structure**: ![structure](./figures/structure.png) +**Inner Structure**: + +![inner_structure](./figures/inner_structure.png) + ### ylong_http_client crate `ylong_http_client` crate supports HTTP client functionality and allows users @@ -62,6 +66,9 @@ ylong_http_client = { path = "/example_path/ylong_http_client" } ```text ylong_http +├── docs # User's guide +├── figures # Resources +├── patches # Patches for ci ├── ylong_http │ ├── examples # Examples of ylong_http │ ├── src # Source code ylong_http diff --git a/README_zh.md b/README_zh.md index 0914943..ea13508 100644 --- a/README_zh.md +++ b/README_zh.md @@ -8,10 +8,13 @@ ylong_http 向 OpenHarmony 系统服务层中的网络子系统提供 HTTP 协 ylong_http 协议栈主体使用 Rust 语言编写,为 OpenHarmony 的 Rust 能力构筑提供支持。 -## 架构图 +**架构图**: ![structure](./figures/structure.png) +**内部架构图**: +![inner_structure](./figures/inner_structure.png) + ### ylong_http_client 库 ylong_http_client 库支持 HTTP 客户端功能,支持用户创建 HTTP 客户端向指定 Server 发送 HTTP 请求。 @@ -56,6 +59,9 @@ ylong_http_client = { path = "/example_path/ylong_http_client" } # 请使用路 ``` ylong_http +├── docs # ylong_http 用户指南 +├── figures # ylong_http 图片资源 +├── patches # ylong_http 门禁使用的补丁资源 ├── ylong_http │ ├── examples # ylong_http 基础组件库代码示例 │ ├── src # ylong_http 基础组件库源码 diff --git a/figures/inner_structure.png b/figures/inner_structure.png new file mode 100644 index 0000000000000000000000000000000000000000..d5ad865c248eaec4c05af625b14e0522bcd4a840 GIT binary patch literal 13611 zcmcJ0XIN9)wsw?_Y(->eD+1CKL{tP+dW|K5N)ze5gBU^!gc2awFrt8IjHbyKkjk6bM%<9t+6w9|Obwz9D8qlP=Z(_d=Lg%@i- zcwFm=UwP@t^Nn3f7j)SlE*c$X1stXa(2n_CwqI(YO??roN1#Aq z?>=BZr?{E?e?R;!L>}Vfd~5V;Y?&mCbT&xH!}F{K4=5=5B1cavrIPbZ`~@>Y@YEwv zBd`U*%*i5cQ#n7%$t%l$>@92}&N4>9yR~~PN*(*&-2qssCc4h%M{GFmjEnTVuRU|8 z%KcPx%5Q}{NRQF43+YfOwBO(5weAJ;lB$|-pQ0$N6^(~k0asYR zlfx#AgBTfk7)-8bfHZ2(m33DHe94a~KI^Z-s1b)NpUYv!KNI&?A6~9#&TnVdH837m z6>Jb=>!y3xQWrSHKIG9B-QZ*WV--2lh(-SiL3*Q5=1Sbtg}RyPuZNyU-Q25gf| z*WYI(Ube*h8$+RL%(ZUOE}XZcrBIs(37F}}h|FT=uHr36Xb~GK-SlnNg>6S0`A%P< z9VLg^n3@LylluF+8^GXhb;c_UCa+CfB{hLz@Or#qPO=8(SzE6ry27y`Dq3U_#MlNK z1hqORrY{9C)-l7I4aWg_cNuxqnKu^zahF=+`E9qSg>QV+%a+DNk{8D`#r>(06UnAw z?=%zGf=H%Jhd^^EmH2~5sZk!vm!{typ4C4O7nxHj_HFaNz4W7B5$Qi>V-duBFFbtw zq}yk~9*!=&@6rHfq_nhDLA80OIc~geEs|^v1{-KJ^uKpkl*2Q}Zdnb&eBwCfAi#Lu zvekFG`knz&qJRh=Rs~@d#YOFwr-pw#qERt(4p^w^o8s1`rvZ+OQtBfhZ&6*;p*oT3 zkDpQ{LtmzXyNnyYrCh#3`i&f>;XM(lT@2`0HA%Eh8dve$psEd3W_f(Uv$bJN3@265 z~X{GjjMH89z65j(7=p7&8~-0Bp9Z*cz8tlzcQ>Vo?HZ)3?lh6Ihvq zV?Iun03G18KQbrFQ2CT(uwJiT!~5%Oww3C6U?-6o!WR?FWH~@Rq=G~?(8+6in3MEp zG3Re6CIE<)@-c?gsD+nAii5(g!bh4Nx0;_@KYJzL^M$B|e@+sX{&{2ZsMzmE5ZUJY z{weBt1$RPh%q~+N#+q}&EF)~5;shd0p6rieKvt*5*-BzRegh8g(dXn!McX?*2o%)*4udnp+0SiyoVVw^u4kA9D?D?@+TsSgb_$VZ2g`(XiCQ7zO_I@}%*e%b| zr_f`2;_%A|??C~q5ijodk3Eh~M_LLQwRX4YyWir)%cajI`h6mb;LQQ3^0a+f^S=Md zHic03L=bW9yO2yxP0>47*osQr=v_tsA@)H5F;R!jJbqvnaAyyy@`)=N*RUovep@Z< z5?9J$XFLc zOToVnkV3DvVzItzi>(XhXlqjFHOtqdWv6KYR2yRk!`AOFAZE#>P|(8qRo^82WH--N zi^LEhlL^y(zS!h~+L;05I{w$U5|5QnIt)1@#6&Z;BRfvsK}xZR_*{N}>IW`T7dbkQ zR@YZM6E`GPJm6e3zBMfL>h^2ajJ_qdu54Wf{~H*L9~-~>V+CKhaO;Mwb5*FT4b%yH z;zj<%h{@Ad?JAGJto3&beGfSZ&$kDo%*y=QB?AXhKF++3FP}hGMAEABxLDQqwV)jg z!cd*SAf(Seq3|Os&6}RgVZu z4YuE2aldw7Ada{kWNI%>k7;ME>|mk1kz=;}#~X3VAvq4LDaz!9$^fVUE8dt_)Q#WFf?+OjVIu zI?QQpRd`5C?rt(Q{>cuZoHo$nv3jAxGUMaSC_55wQThXTH+f%Q=y3U9XcQER6uIs< zfl~tjwoS@8f2rb^l2_e>7iea)=DbEM!a>+tO%i3clBAAvFTy##Y|dBycnPq5U8DdM zx-HVR6!d^qU<@Znl{b_Gk4qM!`v+T0w5IbEi`qRBFqjqmuA7IZ)}@mBuDAY(ZpK6dC|7@# zwvXZ7vnDK|n;=OASRvy}W6>{%#a$!$PLG#PuWOl~b>d#E|hGlaT5M8I26&+lWiYA=_eMkL(T&=5t! zw{B>cQrJQ?6U0ufvv&166N?+x6!RO7b?Q%8`K))u(&`hGhZqD`j3H2sDXU{#xuF(R{^_s#cpwxHi* zB|2grJ~wd=pV|mPHw`8($%|&JY4gm0mx<(XOjXX0ZQC6kauOFBwHOhSD3fl!?WFCr zGe=YFXH|0S*t$ej?oRP%*(O=@faxdFJG&~X20~Yp*8^P_Zrx0~sC5F6yD&Ngd!F7| z#DkVcw91IyX43n#MW+&T&|t6>Zu7>A;_8aiC_Ss)dlbj+Ve8+)rI}gcQ;qU|xQvjZ zjoz8*h~=wc%$M7n8qUl&O*gE3N5x|l`^U;qw$R{8>2jCp_~&bT9D6ib|fe-=C!;N7ao`T(!jp07T)2x--MtA-71?M`>2AUP$s ziLWulFaFSq0S&h-&ck|K5E(hHq-3|kx|wa_O%||WKLk8K?eW*ZZb7$^O$NUy8p66V zDB_eBE@NS&p4G6FxHG%rs(Gk(u1q_FS(D4^>Y(~0YByN+n+~!^=McN!u)4l)Y;IZNA1HaRmL@_qJAmfrG`qOEK1M$tP z<*C?wyt#;BJgeJ1M<=%H1lTq5EK)q^(S(?BP^{DXZQAlPu(t~fdDZnWty1+wqL^Q& zzQ$bIX$# z*T0rmkSN)a$2;db)Ui*ZIZ0XUUk@V{3PyPNP9I^?xJis|)_J6qogF`;wO@-d!QWWa zcqL~utZPkJU9@98%Ad80->4AY8xnSo|AVT=sd|oMZ#U--_80sw2Csh*$@i0Yrq{V; z(&D#0uTL{En2}oN<#kn3Q~+u`yn`1cG_S&UD4Ykk-|Lzs_Cf=kR(->?Fx1Hj3KhIx z7pmPaR^FypNxU983}N1$G1lgdQkyxypDnuR(YtF2j&BL9IXFrt_(wR*wL*yBe7U7y zSGMUw3O>jlKg`M3<12Jn=(8Xjfk3etWp2xmE=_OEx>py!TZ_`lj(SEd4}d~-ssjlH zWtb5>V&>r{xd4LdfB42ybZXVMVLIl6qXR3m|3sD6*ZgQ1o1;Rg;FE#1N5X%Hk@-fL z)9e0@yDgW-)ljUiIBdP5Cxa^=JMPt-u_=7tmaBa89d245J6;lGIrF5rVV9e7d?{A=UuG8x?Db?tl3Q;8n^@o z&zeY|7+=|WH#G?6^YRrs-6bcE(68E1{@0 zA%+mUD}8p*M=geSFVN3_7-7w+H`88dMG1+Jb?v->wIA~(I(`%= z_hK$2s+vj%1bA;;@hCQTm30{}z4s-AQ#kap|Jbs&G`;O{b)o&TVb%LjC*M=-T9p1i zs`~r4E{*8l?RjL;Z9V0Hkj@2u#%7q|Fsr^lMopQV*)g84mVR(opN;jXM`yOcGwoLCv68UUjxF=spVos;-Qz7B&{K zt0RXnN-$`tWUs)Q@O&TYbe?HYwEhc>EFH_K;uugo-YX~h=kiFaSaZ(RVV+m3oylZ? zTGF<)n)I1d{^*hqX6x^AcHt%wH)t^`=;T2Fc)s%D@9X#Ywl^dqr7g|{xrL&gLjgRU*j8TrbNsEyaLuiuu)QZdkVC3bXElhv$)()_x zBQFovbKH`>Y?|OofmW*9pi1Hv;k8G981#4#WS7BlF8ybdl7dlKMqlH+uX1p=WytH&(8{V!?NQP58;2`rJPI zC_}7Y`xId#%F=gmK}!<|Yu`0duyX2`^9z18RvrjoOcxv3RQgV~7)s|YzG(w)ir{H! zG5NF;AiTZZ%U;wKnTwrmAIAO)cXh&EPB*-FrW_;9mC$}NYQs?l)!x_C)-?@1jSjYC zZid;|J4G3;Zq%Aqp_%Re9dlF7bpIl&A3oY-O1orvbk5IT6DjMio^89i@DmyN(=j2z z(HP7@MNb%ovg+b0U2GL%>g1|u6B4|fRQ=0IGHcQ z`ciwnS+xN@+eVm3#xlbP2_Dssy(n&L{OTeG!-&>H?Y1t*0eD&xMBwsILFb<9sz(xx zS2aYYk6Tv)*M_^48j~uN2da^P!(s)umK&u zU*-ZyZEB5amNoZ$+bQr=y9d*{ell3A(5o)GYYB;2(>8GC43j7uvIItUeE!g!n56t6 zsg4dnA+J6vV7X$$Sg4VpWrex5WKV7+v_#Ah|!B4etLxZ+&eB%`&qX- z%1TaTM8p{kc8!)&d)2eO_4mM>J})yj5fT3?|JJOvAF$%tC{v9)2@}_8S7pF}7XOCQ zs`a{d-$#~v0nEo(K`L4G@k*$!8nAlubv|We@C!;sBXv<4&2>!r9rpg++?1GJ)tN6n z8Jj(*9&Md+pNOv1ot)=Wt?b;8+RDWqrdAHzE#fSI!U1`w{M9@cZ*s?lIA3c|N|#^i z<_Ya)wsa*_$lMJ?jdx{Z>V#KEeho%f)e*C8?A$V4 z!Yy$AR(?ujj+ry8_&PrrEkn^$nadztfwTQ+!gqW)&v zCUY_XFR?kkntUB)p-OXlcna>&+VU)Yen}>~T=T2B*iMBC14`SMQ^Z33?;z=a=MVmp zy8jYk{oty@nuLCIYzzSAU@#YJ*FO&J11p7Hg_23^5*eF(N^8PwPbV_9{>T0BZO#l> ztCxS@Ls)ChAZh{FdkEuTnxQzS-j}s`)2Mh&IGqpdy5Y&|`!h2Av!NT=v-~)@Sn|wl zvSQ~bmQGrYev!W0NMqU=mM&b^-zF3sdp;rN$5hCVQ9kfYCe&>R1J1#Qs0M$Xx7}SS z5FO&U`DEhJ06#!X%l#q%FBZ#MbnM0+&p(s$ix}cq%!HVmCiz9jr2wnaA446}>p#Fb zw#)0lmV{372XV)`I2B#&9(r~kRkvZ6DhNz?Ga&|`1u!8Om|(&^^zl{?>SfVSSL^)) zjow;9Gfe?iS}C#OZQaq#&w*I#cIP{X;U|25$71TWbgWZ;e5n6ftU6w~B4-ef zp0oRD8T_N2ubxun@+a6-D6EMufI|f}p8EGIF@GZrds)$o->GO{i!U1+o?6|O5d0L8 zs_0ov@Up!=FBGjK)Gxv_TI2Hxg{bO0PkD;kSAT`JkNqIx*ws+pI##b6w@gEw&${)j zFe^z|nQ_``rENi8fB<(<}W zhNn!*iNK@cx|?ddJ%(T~uSUR^N?Fk=5A$G4;;x;VFJS_MN$^5=L`^UH2`pKzdQ5yG zT6OG^*;hEVKm3{|6w1upWu{8<))D(kKkhlNOa84Lc}`0cbg_LOTLIq#aL8XBHT;ov zI}>PVu!{e8U^U^f%^B4yU7@4B6&|w$*~{ESl*o?x%mTbzwBOtoy|Jf=qjWUCt$97% zY2%yvY+(b12*X;hqx}-jjc>C4#}3z*F#u98=D(Qm#1PRQuhmUA$^L=Z^Yr_wmvmP{F zq3r{Ll26QVd791Ex7|zN?dV2l|M8NYqP>`ie%zg(u+0OalVH!vXHx`pH|vP8mfst8t%zk0px-+5<#EkrS;T+^2 zfy3wtz3R~~{#K5O%z!731?8+9a923eL;K<{tT zKAm)R`qyi}H5?=M6^uDyE0 z-vv0leqR&50+H=J^e>mC*%;k{T=an8&$i0H1WnQK*p+Tia|>Vt=lJ7SY$yLAqjLC) z%-LkKzKR?mZ~`f%$%Z#4*2`Hr|9b(O(s!|B5a<|ruNUAy@~G5`Os(jRwIuE%%}=#< zGA@H8JU{Uul0vtEP^gVb;2mZ;0bY;IOYlEc<*qvHG?wc@7;9CYS}&ABfFBWNB4JE> zrz3o7ZD-=YqX~fEX7c-#G=OXjJ8_K{>vCXL^Mw*48(&>HGPrM!8z}8v&4PP%l?YyZ z$)Ct}_JXXEtJx7gl><91#1htO`WIF=o#88Mcc*$KX+a{?%5+ar$}6Si8apEr^wp?( zrOS#yB`r}zNNGBg4HyZsySd{vGQu4mx!A3mIHf$DE3u+7bNHk0*IWjCMVHGtIPzAFiAEt{+2Z&-F(*dzN7|N2K8!&}}N zllQvTqdiFX)wb9Vh}+rHc_HQB#38nq41{y9eiE1-8tbN8c;~!4XGldcMYJ>T}pp)`O_08m_Sn2 zeIqNK;=4nR19|~wZS!-w%*$$~-5~Y2??Y%f1A+?_G02d}?PcMF-vO)k#cV*elLM#>aj$*l~r8E!=7F zg;Tn81z6Pby>5X13W@k4_;{jeeLB+-D4T&ofWmChu!z-0B?cpuY;!*f(`iW&6J^eo zji%~#FweHVu`x`ezNco>oXf2Vx!=>qJyY(+fPh5bzWRcd?Bq7F47b&CPcqpIuaH?r zS1(f%1^mXecj7*R1f3F7!NSMv;mU)g*7f3^0P;Iu@<`}Q5 z*k12=JM^`+nbXgDdwoKEugcYGEd18?AmU1Kd)L#Yk%~Z5=*j$yD+=Tj; z{;Xz^sG%6LNN5g+z)3x)<_2u7U&%ZNtW5TEO&f2D;ek0>ps9dN6 z^Ql!DPP?D-fKnB@u+bd?LGugcg5IN>;gzKXY% zVws((hUMyba@)^pRGY_G683r30!?Mfk9`jHkBOdd9nnWpmU|zB*7EnjLakAqk&;QG z4I70+tQ;ICS#PxajZQsIBO`cztU=$XhT9C;KP2MsDhTH5(GXPFcx3Mg0Kk7jBaM>n z=END;IBCc0_at=nS=#z%d{O-w+1@~6>6Ngnu6rez!{<98Rs#*lMHp#;{CNIWKHg8S z8FCUlqwQI&JV`znb`_eywxfyHD{8z&HxpSR7J6eIAk%f`%76NYuJKgez29()96JK7=BiEMQ3pLFZWlxg4eq%n+ zQQlAQiQCXScT#MG!~#%oUzl*t&lW+I1ow>y6^G;%E$7FTdfsY0+KbeC3T9q=Qnx3E zE*Oj`a%VJch0{fHCys$RT#Vei1n2S5E#JJS;*XDp2RRc*YwTyc?^o)&2^AEY
  • l z60EbUnWgQNJXqH`Gap`_FdMHQqfKna!^X2F$Bwz@_r7EAItPQ4SJWHAZEO`Yy(1bA zUVj-=bIO?%tD4*`Kk z0dIskYs=cE%i1&FvkBO!@yRR}MH4^iD0&C8b3Vf;mEgpIjvd_}hU zQfH)-PI^^v--B_f(RPXt_wQMp(nS&3Iks(Swl;`B@>mFNH0>(^XNawnM_d9=|`x5Xz} z;7%zTR4}*b-hI`aI?*J{iD$PAYgtC7B`=j`KSyph82Zezt%GOe6DR-jgyLgb3klfRT3q-sl>?VA(tq}b-B z%gyv5YCZC;kzL?ft7_k_2R!~B6PH}ehP$}THOb)#^ZoJq7PzUj#WzDX)p;Hp#Dz-n zN^s({LJVd(kfVKJNh%*Nix|yK!nt_nhGsY!LSIET^d}&6czi^5}>!`zWpU&sUN2v4;izap%ad@fF)>qp}3>{KOp z6gvQEaH03U|J7MF|69S-|IoZ!^MGat?_|@qQRzBJ2XLq1U#bbi5&OB`jU#x^FzGOmw)3+)HeIV;O+>Ro*Jqhonc4s4oz?s z$4RN%{3>8^l|)WAGWpcz9u8PVIAhwK-=V!#suh9{ZDvg^QAk zak}T!y<*wZ5R*+!3rUEeOpn8wn&i9QB~>nq5yPUQc}vz+_k*BNV1-J}ua>mqb#Eto zJ5|Y6=7GfDSLCsEM_*<8(!3V|eUFU~k1K6!CGKyQE{4&ZeI7}Jdli1`3#HUO0{?Wq z>p&JrKIcO5Zr$`~p372zGjSUl!e@J{1#};q#jAU+czm5|$vc#C^vRgn<00+hM6c15 zPDxuevsb7KZlT_$16HA<0=l>|399AYWoSiZ{hPFNHL@!NO+Xb!o)H)}+4Bm`DUz1O zA^slgMcaOZ^0Q9T9dbFC-2=OTLmf=^_f;BswPW)xVg(tC6$$v?0B$zNRk9~{Org-CoYsYDAHr&{}0 z$sGNFM{GI+S=Nd` zd)3g3NPu4{NK;a3eLCIDDfQ0laIUS!EgSl$-3ArHM!XPKC-zK7*1J0LN=J|BOl5hy zEo$~L{#Y`A;1IXAtU$+=X35Dc*W2gQMh4eESFccI3Xk9;4jtPX+K5YTk}hsfMRYxp z?-#QftD34TtF>x2sQosTcQ0rsi@Hp7AInXm_&5q|H+LsqME5=5k`eA0_fE2X>~_ur zw|MuHLiTzet_!$zx4&(jL#)4K){6N2)qCSj@`;5tw{{65AGK=!=^1 zO=4F?t-K%U@hMS0)E%{Fhu&{%GvK*mZIXIFzHsh)kkNt{xWZ%?RQ-Y)R_abdeWd^w{k;>x3GlcP!#mo7KgU)LHypbZ;$tjlOv1|`3IZ9N z>#tm7lG4;0F4NnxLbR7UxLkD7t=7lLmOjM}_p3=1TzEu-JC*|m6V9D@oqSPhq^ZIt zh_rP>-jSjx&towZxbgj#0V_Bg;I<3{!yKTwQd|XQ2^p(nKG^{f&GD{#fE5AyL}~Pg0tfsDiljbthFaSorkmKU;}r6;k)x04A_)ei zKnG+WwXhO=Db#p6&R`kZn%yGQv3o)o|I_*Fv^x83#t)Jb&z)uk7>(oHjW;z8x>4vz zf(5}O;HMeUZ}VDN8RO_>``cBt28r^h>wej8k$a?|*iXgz4+?OOY&9ALf0}M&{8fsF zn~J$dvR4loTe$_3HQY6pFK^F$9#gY>dGP@s^q=_nS0R_WKWxDfb*v!p5~?j}c(^lQ z+JSYO{>6N@Sz>2-FuAp=b*aaLBNuR9k815VA4JjQPGu^dSa|xSDfD6iho_&0-(Taz zY;%sp5ZHZgqs}#fn2LK?kVLl}<)kd2fij2TeL=Tz>_5LndH?wpH+uq*KKeI4Jpo#B z*am+Xc$<_`K7tg3jnE_@*h^o(E;d}E?8hJqaI1Z`;tgko9%eBdO!u$cdv*Bs35Ar) z|3?wvKcuhr*vPkEqJpUfd