489 |
1107 |
1108 | Procs
490 |-
491 |
proc absolute(path: string): string {....raises: [ValueError, OSError], tags: [].}
493 | - 494 | 495 | 496 | 497 | 498 |
proc as_uri(path: string): string {....raises: [ValueError, OSError], tags: [].}
501 | - 502 | 503 | 504 | 505 | 506 |
proc chmod(path: string; permissions: uint) {....raises: [OSError], 509 | tags: [ReadDirEffect, WriteDirEffect].}
510 | - 511 | 512 | 513 | 514 | 515 |
func compare_paths(pathA, pathB: string): int {....raises: [], tags: [].}
518 | - 519 | 520 | 521 | 522 | 523 |
proc copy_dir_permissions(source, dest: string; ignore_errors: bool = true) {. 526 | ...raises: [OSError, IOError, Exception], 527 | tags: [ReadDirEffect, WriteIOEffect, ReadIOEffect].}
528 | - 529 | 530 | 531 | 532 | 533 |
proc copy_file_permissions(source, dest: string; ignore_errors: bool = true) {. 536 | ...raises: [OSError, IOError, Exception], 537 | tags: [ReadDirEffect, ReadIOEffect, WriteIOEffect, WriteDirEffect].}
538 | - 539 | 540 | 541 | 542 | 543 |
proc counted_lines(path: string): int {....raises: [IOError], tags: [ReadIOEffect].}
546 | - 547 | 548 | 549 | 550 | 551 |
proc cwd(): string {....raises: [OSError], tags: [].}
554 | - 555 | 556 | 557 | 558 | 559 |
proc dotenv(path: string): string {....raises: [IOError, OSError, JsonParsingError, 562 | ValueError, Exception], tags: [ReadIOEffect, WriteIOEffect].}
563 | - 564 | 565 | 566 | 567 | 568 |
proc env_vars_pairs(): seq[(string, string)] {....raises: [], tags: [ReadEnvEffect].}
571 | - 572 | 573 | 574 | 575 | 576 |
proc exists(path: string): bool {....raises: [], tags: [ReadDirEffect].}
579 | - 580 | 581 | 582 | 583 | 584 |
proc exists_create_dir(path: string): bool {....raises: [OSError, IOError], 587 | tags: [WriteDirEffect, ReadDirEffect].}
588 | - 589 | 590 | 591 | 592 | 593 |
proc expanduser(path: string): string {....raises: [], 596 | tags: [ReadEnvEffect, ReadIOEffect].}
597 | - 598 | 599 | 600 | 601 | 602 |
proc get_conf_dir(): string {....raises: [], tags: [ReadEnvEffect, ReadIOEffect].}
605 | - 606 | 607 | 608 | 609 | 610 |
func get_dynlib_format(): string {....raises: [], tags: [].}
613 | - 614 | 615 | 616 | 617 | 618 |
proc get_exe(path: string; followSymlinks: bool = true): string {. 621 | ...raises: [OSError], tags: [ReadDirEffect, ReadEnvEffect, ReadIOEffect].}
622 | - 623 | 624 | 625 | 626 | 627 |
proc get_file_info(path: string; follow_symlinks: bool = true): tuple[ 630 | size, link_count, block_size, permissions: int64] {....raises: [OSError], 631 | tags: [].}
632 | - 633 | 634 | 635 | 636 | 637 |
proc get_file_times_iso(path: string; follow_symlinks: bool = true): tuple[ 640 | last_access, last_write, creation: string] {....raises: [OSError], tags: [].}
641 | - 642 | 643 | 644 | 645 | 646 |
proc get_file_times_unix(path: string; follow_symlinks: bool = true): tuple[ 649 | last_access, last_write, creation: int64] {....raises: [OSError], tags: [].}
650 | - 651 | 652 | 653 | 654 | 655 |
proc get_md5(path: string): string {....raises: [IOError], tags: [ReadIOEffect].}
658 | - 659 | 660 | 661 | 662 | 663 |
proc get_sha1(path: string): string {....raises: [IOError], tags: [ReadIOEffect].}
666 | - 667 | 668 | 669 | 670 | 671 |
proc get_size(path: string): BiggestInt {....raises: [IOError, OSError], 674 | tags: [ReadIOEffect].}
675 | - 676 | 677 | 678 | 679 | 680 |
proc get_size_human(path: string): string {....raises: [IOError, OSError], 683 | tags: [ReadIOEffect].}
684 | - 685 | 686 | 687 | 688 | 689 |
func get_suffix_index(path: string): int {....raises: [], tags: [].}
692 | - 693 | 694 | 695 | 696 | 697 |
proc get_symlink(path: string): string {....raises: [OSError], tags: [].}
700 | - 701 | 702 | 703 | 704 | 705 |
proc get_temporary_dir(): string {....raises: [], 708 | tags: [ReadEnvEffect, ReadIOEffect].}
709 | - 710 | 711 | 712 | 713 | 714 |
proc hardlink(source, destination: string) {....raises: [OSError], tags: [].}
717 | - 718 | 719 | 720 | 721 | 722 |
proc home(): string {....raises: [], tags: [ReadEnvEffect, ReadIOEffect].}
725 | - 726 | 727 | 728 | 729 | 730 |
func is_absolute(path: string): bool {....raises: [], tags: [].}
733 | - 734 | 735 | 736 | 737 | 738 |
proc is_dir(path: string): bool {....raises: [], tags: [ReadDirEffect].}
741 | - 742 | 743 | 744 | 745 | 746 |
proc is_file(path: string): bool {....raises: [], tags: [ReadDirEffect].}
749 | - 750 | 751 | 752 | 753 | 754 |
proc is_file_newer(pathA, pathB: string): bool {....raises: [OSError], tags: [].}
757 | - 758 | 759 | 760 | 761 | 762 |
func is_fs_casesensitive(): bool {....raises: [], tags: [].}
765 | - 766 | 767 | 768 | 769 | 770 |
proc is_relative_to(path, base: string): bool {....raises: [Exception], 781 | tags: [RootEffect].}
782 | - 783 | 784 | 785 | 786 | 787 |
proc is_root(): bool {....raises: [], tags: [].}
790 | - 791 | 792 | 793 | 794 | 795 |
func is_root_dir(path: string): bool {....raises: [], tags: [].}
798 | - 799 | 800 | 801 | 802 | 803 |
func is_valid_path(path: string): bool {....raises: [], tags: [].}
806 | - 807 | 808 | 809 | 810 | 811 |
func joinpath(paths: openArray[string]): string {....raises: [], tags: [].}
814 | - 815 | 816 | 817 | 818 | 819 |
proc line(path: string; line_number: Natural): string {....raises: [IOError], 822 | tags: [ReadIOEffect].}
823 | - 824 | 825 | 826 | 827 | 828 |
proc lines(path: string; start: int = 0; ends: int = 1): seq[string] {. 831 | ...raises: [IOError], tags: [ReadIOEffect].}
832 | - 833 | 834 | 835 | 836 | 837 |
proc mkdir(path: string) {....raises: [OSError, IOError], 840 | tags: [WriteDirEffect, ReadDirEffect].}
841 | - 842 | 843 | 844 | 845 | 846 |
proc mkhardlink(source, destination: string) {....raises: [OSError], tags: [].}
849 | - 850 | 851 | 852 | 853 | 854 |
proc mksymlink(source, destination: string): uint {....raises: [OSError], tags: [].}
857 | - 858 | 859 | 860 | 861 | 862 |
func normalized(path: string): string {....raises: [], tags: [].}
865 | - 866 | 867 | 868 | 869 | 870 |
func parent(path: string): string {....raises: [], tags: [].}
873 | - 874 | 875 | 876 | 877 | 878 |
func parents(path: string): string {....raises: [], tags: [].}
881 | - 882 | 883 | 884 | 885 | 886 |
proc parts(path: string): seq[string] {....raises: [ValueError, OSError], tags: [].}
889 | - 890 | 891 | 892 | 893 | 894 |
func path_splitted(path: string): tuple[dir, name, ext: string] {....raises: [], 897 | tags: [].}
898 | - 899 | 900 | 901 | 902 | 903 |
func paths_quoted(paths: openArray[string]): string {....raises: [], tags: [].}
906 | - 907 | 908 | 909 | 910 | 911 |
proc read_bytes(path: string): string {....raises: [IOError], tags: [ReadIOEffect].}
914 | - 915 | 916 | 917 | 918 | 919 |
proc rename(source, destination: string) {. 922 | ...raises: [OSError, IOError, Exception], 923 | tags: [ReadDirEffect, ReadIOEffect, WriteIOEffect].}
924 | - 925 | 926 | 927 | 928 | 929 |
proc replace(source, destination: string): string {. 932 | ...raises: [OSError, IOError, Exception], 933 | tags: [ReadDirEffect, ReadIOEffect, WriteIOEffect].}
934 | - 935 | 936 | 937 | 938 | 939 |
func replaced(path: string; replacements: openArray[(string, string)]): string {. 942 | ...raises: [], tags: [].}
943 | - 944 | 945 | 946 | 947 | 948 |
proc resolve(path: string): string {....raises: [ValueError, OSError], tags: [].}
951 | - 952 | 953 | 954 | 955 | 956 |
proc rmdir(path: string; check: bool = false) {....raises: [OSError], 959 | tags: [WriteDirEffect, ReadDirEffect].}
960 | - 961 | 962 | 963 | 964 | 965 |
func samefile(pathA, pathB: string): bool {....raises: [], tags: [].}
968 | - 969 | 970 | 971 | 972 | 973 |
func stem(path: string): string {....raises: [], tags: [].}
976 | - 977 | 978 | 979 | 980 | 981 |
func suffix(path: string): string {....raises: [], tags: [].}
984 | - 985 | 986 | 987 | 988 | 989 |
proc symlink(source, destination: string) {....raises: [OSError], tags: [].}
992 | - 993 | 994 | 995 | 996 | 997 |
func symlink_exists(path: string): bool {....raises: [], tags: [].}
1000 | - 1001 | 1002 | 1003 | 1004 | 1005 |
proc tokenized(path: string): seq[tuple[token: string, isSep: bool]] {. 1008 | ...raises: [IOError], tags: [ReadIOEffect].}
1009 | - 1010 | 1011 | 1012 | 1013 | 1014 |
proc try_rmfile(path: string): bool {....raises: [], tags: [WriteDirEffect].}
1017 | - 1018 | 1019 | 1020 | 1021 | 1022 |
proc walk(folderpath: string; extensions: seq[string] = @[""]; 1025 | followlinks: bool = false; yieldfiles: bool = true; 1026 | debugs: bool = false; check_folders: bool = false; 1027 | prealloc: Positive = 99): seq[string] {....raises: [OSError, ValueError], 1028 | tags: [ReadDirEffect, WriteIOEffect].}
1029 | - 1030 | 1031 | 1032 | 1033 | 1034 |
proc walk_files(globpattern: string; prealloc: Positive = 99): seq[string] {. 1037 | ...raises: [ValueError, OSError], tags: [ReadDirEffect].}
1038 | - 1039 | 1040 | 1041 | 1042 | 1043 |
proc walk_folders(globpattern: string; prealloc: Positive = 99): seq[string] {. 1046 | ...raises: [ValueError, OSError], tags: [ReadDirEffect].}
1047 | - 1048 | 1049 | 1050 | 1051 | 1052 |
proc walk_glob(globpattern: string; prealloc: Positive = 99): seq[string] {. 1055 | ...raises: [ValueError, OSError], tags: [ReadDirEffect].}
1056 | - 1057 | 1058 | 1059 | 1060 | 1061 |
proc walk_simple(folderpath: string; relative: bool = false; 1064 | check_folders: bool = false; prealloc: Positive = 99): seq[ 1065 | string] {....raises: [OSError, ValueError], tags: [ReadDirEffect].}
1066 | - 1067 | 1068 | 1069 | 1070 | 1071 |
func with_name(path, name: string): string {....raises: [], tags: [].}
1074 | - 1075 | 1076 | 1077 | 1078 | 1079 |
func with_stem(path, stem: string): string {....raises: [], tags: [].}
1082 | - 1083 | 1084 | 1085 | 1086 | 1087 |
func with_suffix(path, ext: string): string {....raises: [], tags: [].}
1090 | - 1091 | 1092 | 1093 | 1094 | 1095 |
proc write_bytes(path, data: string): string {....raises: [IOError], 1098 | tags: [WriteIOEffect].}
1099 | - 1100 | 1101 | 1102 | 1103 | 1104 |
492 |
499 |
500 |
507 |
508 |
516 |
517 |
524 |
525 |
534 |
535 |
544 |
545 |
552 |
553 |
560 |
561 |
569 |
570 |
577 |
578 |
585 |
586 |
594 |
595 |
603 |
604 |
611 |
612 |
619 |
620 |
628 |
629 |
638 |
639 |
647 |
648 |
656 |
657 |
664 |
665 |
672 |
673 |
681 |
682 |
690 |
691 |
698 |
699 |
706 |
707 |
715 |
716 |
723 |
724 |
731 |
732 |
739 |
740 |
747 |
748 |
755 |
756 |
763 |
764 |
771 |
779 |
780 |
788 |
789 |
796 |
797 |
804 |
805 |
812 |
813 |
820 |
821 |
829 |
830 |
838 |
839 |
847 |
848 |
855 |
856 |
863 |
864 |
871 |
872 |
879 |
880 |
887 |
888 |
895 |
896 |
904 |
905 |
912 |
913 |
920 |
921 |
930 |
931 |
940 |
941 |
949 |
950 |
957 |
958 |
966 |
967 |
974 |
975 |
982 |
983 |
990 |
991 |
998 |
999 |
1006 |
1007 |
1015 |
1016 |
1023 |
1024 |
1035 |
1036 |
1044 |
1045 |
1053 |
1054 |
1062 |
1063 |
1072 |
1073 |
1080 |
1081 |
1088 |
1089 |
1096 |
1097 |
1105 |
1106 |